build: set record status in response

[crazy-max]

Similar to #2280, we can set build checks warnings in the metadata file. Does not set anything by default but can be customized using the BUILDX_METADATA_STATUS environment variable to set just warnings or full status.

This will be useful with our GitHub Actions so we can generate GitHub Annotations without having to do a subrequest build like in https://github.com/crazy-max/docker-build-push-action/pull/39/files#diff-4fab5baaca5c14d2de62d8d2fceef376ddddcc8e9509d86cfa5643f51b89ce3dR132

Output example in e2e workflow: https://github.com/docker/buildx/actions/runs/9498949574/job/26178830826#step:9:201

# syntax=docker/dockerfile-upstream:master
frOM busybox as base
cOpy Dockerfile .

from scratch
COPy --from=base \
  /Dockerfile \
  /

$ BUILDX_METADATA_STATUS=warnings docker buildx build . --metadata-file md.json
...
#12 exporting to image
#12 exporting layers done
#12 writing image sha256:d0bb2193d26744307a7003c5397e277d1fa73ee979851b0c2ed2afad89d2e44b done
#12 DONE 0.0s

#13 resolving provenance for metadata file
#13 DONE 0.0s

#14 resolving status for metadata file
#14 DONE 0.0s

 3 warnings found (use --debug to expand):
 - ConsistentInstructionCasing: Command 'frOM' should be consistently cased (line 2)
 - ConsistentInstructionCasing: Command 'cOpy' should be consistently cased (line 3)
 - ConsistentInstructionCasing: Command 'COPy' should be consistently cased (line 6)

View build details: docker-desktop://dashboard/build/default/default/wuiiyvfzfof6q93b69sp97n2l

{
  "buildx.build.provenance": {
    "buildType": "https://mobyproject.org/buildkit@v1",
    "materials": [
      {
        "uri": "pkg:docker/docker/dockerfile-upstream@master",
        "digest": {
          "sha256": "9935ee100536d9becebf9221786409606f46a51736e894796a6e983fae5e446f"
        }
      },
      {
        "uri": "pkg:docker/busybox@latest?platform=linux%2Famd64",
        "digest": {
          "sha256": "9ae97d36d26566ff84e8893c64a6dc4fe8ca6d1144bf5b87b2b85a32def253c7"
        }
      }
    ],
    "invocation": {
      "configSource": {
        "entryPoint": "Dockerfile"
      },
      "parameters": {
        "frontend": "gateway.v0",
        "args": {
          "cmdline": "docker/dockerfile-upstream:master",
          "source": "docker/dockerfile-upstream:master"
        },
        "locals": [
          {
            "name": "context"
          },
          {
            "name": "dockerfile"
          }
        ]
      },
      "environment": {
        "platform": "linux/amd64"
      }
    }
  },
  "buildx.build.ref": "default/default/wuiiyvfzfof6q93b69sp97n2l",
  "buildx.build.status": {
    "warnings": [
      {
        "vertex": "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5",
        "level": 1,
        "short": "Q29uc2lzdGVudEluc3RydWN0aW9uQ2FzaW5nOiBDb21tYW5kICdmck9NJyBzaG91bGQgYmUgY29uc2lzdGVudGx5IGNhc2VkIChsaW5lIDIp",
        "detail": [
          "SW5zdHJ1Y3Rpb25zIHNob3VsZCBiZSBpbiBjb25zaXN0ZW50IGNhc2luZyAoYWxsIGxvd2VyIG9yIGFsbCB1cHBlcik="
        ],
        "url": "https://docs.docker.com/go/dockerfile/rule/consistent-instruction-casing/",
        "sourceInfo": {
          "filename": "Dockerfile",
          "data": "IyBzeW50YXg9ZG9ja2VyL2RvY2tlcmZpbGUtdXBzdHJlYW06bWFzdGVyCmZyT00gYnVzeWJveCBhcyBiYXNlCmNPcHkgRG9ja2VyZmlsZSAuCgpmcm9tIHNjcmF0Y2gKQ09QeSAtLWZyb209YmFzZSBcCiAgL0RvY2tlcmZpbGUgXAogIC8K",
          "definition": {
            "def": [
              "GsUBChJsb2NhbDovL2RvY2tlcmZpbGUSFAoMbG9jYWwuZGlmZmVyEgRub25lEkoKEWxvY2FsLmZvbGxvd3BhdGhzEjVbIkRvY2tlcmZpbGUiLCJEb2NrZXJmaWxlLmRvY2tlcmlnbm9yZSIsImRvY2tlcmZpbGUiXRIqCg1sb2NhbC5zZXNzaW9uEhluOTMwNHpkYzM5Y3B6ajJndjF5MzBicjgwEiEKE2xvY2FsLnNoYXJlZGtleWhpbnQSCmRvY2tlcmZpbGVaAA==",
              "CkkKR3NoYTI1NjoxY2MyNDFmYjIwOGM4N2E0ZjQ4ZTRiZTg5NDY0ZjhiYjI3Nzg2YzYwYTI1NzFmYWY1ZDkxNTg0OTNiNzBhN2U1"
            ],
            "metadata": {
              "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {
                "description": {
                  "llb.customname": "[internal] load build definition from Dockerfile"
                },
                "caps": {
                  "source.local": true,
                  "source.local.followpaths": true,
                  "source.local.sessionid": true,
                  "source.local.sharedkeyhint": true
                }
              },
              "sha256:3e90e4df9cb0f8a6679e7bdf9d853abc823fc04386a4c5c226cea5f7d1bb4ac6": {
                "caps": {
                  "constraints": true,
                  "meta.description": true,
                  "platform": true
                }
              }
            },
            "Source": {
              "locations": {
                "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {}
              }
            }
          },
          "language": "Dockerfile"
        },
        "range": [
          {
            "start": {
              "line": 2
            },
            "end": {
              "line": 2
            }
          }
        ]
      },
      {
        "vertex": "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5",
        "level": 1,
        "short": "Q29uc2lzdGVudEluc3RydWN0aW9uQ2FzaW5nOiBDb21tYW5kICdjT3B5JyBzaG91bGQgYmUgY29uc2lzdGVudGx5IGNhc2VkIChsaW5lIDMp",
        "detail": [
          "SW5zdHJ1Y3Rpb25zIHNob3VsZCBiZSBpbiBjb25zaXN0ZW50IGNhc2luZyAoYWxsIGxvd2VyIG9yIGFsbCB1cHBlcik="
        ],
        "url": "https://docs.docker.com/go/dockerfile/rule/consistent-instruction-casing/",
        "sourceInfo": {
          "filename": "Dockerfile",
          "data": "IyBzeW50YXg9ZG9ja2VyL2RvY2tlcmZpbGUtdXBzdHJlYW06bWFzdGVyCmZyT00gYnVzeWJveCBhcyBiYXNlCmNPcHkgRG9ja2VyZmlsZSAuCgpmcm9tIHNjcmF0Y2gKQ09QeSAtLWZyb209YmFzZSBcCiAgL0RvY2tlcmZpbGUgXAogIC8K",
          "definition": {
            "def": [
              "GsUBChJsb2NhbDovL2RvY2tlcmZpbGUSFAoMbG9jYWwuZGlmZmVyEgRub25lEkoKEWxvY2FsLmZvbGxvd3BhdGhzEjVbIkRvY2tlcmZpbGUiLCJEb2NrZXJmaWxlLmRvY2tlcmlnbm9yZSIsImRvY2tlcmZpbGUiXRIqCg1sb2NhbC5zZXNzaW9uEhluOTMwNHpkYzM5Y3B6ajJndjF5MzBicjgwEiEKE2xvY2FsLnNoYXJlZGtleWhpbnQSCmRvY2tlcmZpbGVaAA==",
              "CkkKR3NoYTI1NjoxY2MyNDFmYjIwOGM4N2E0ZjQ4ZTRiZTg5NDY0ZjhiYjI3Nzg2YzYwYTI1NzFmYWY1ZDkxNTg0OTNiNzBhN2U1"
            ],
            "metadata": {
              "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {
                "description": {
                  "llb.customname": "[internal] load build definition from Dockerfile"
                },
                "caps": {
                  "source.local": true,
                  "source.local.followpaths": true,
                  "source.local.sessionid": true,
                  "source.local.sharedkeyhint": true
                }
              },
              "sha256:3e90e4df9cb0f8a6679e7bdf9d853abc823fc04386a4c5c226cea5f7d1bb4ac6": {
                "caps": {
                  "constraints": true,
                  "meta.description": true,
                  "platform": true
                }
              }
            },
            "Source": {
              "locations": {
                "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {}
              }
            }
          },
          "language": "Dockerfile"
        },
        "range": [
          {
            "start": {
              "line": 3
            },
            "end": {
              "line": 3
            }
          }
        ]
      },
      {
        "vertex": "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5",
        "level": 1,
        "short": "Q29uc2lzdGVudEluc3RydWN0aW9uQ2FzaW5nOiBDb21tYW5kICdDT1B5JyBzaG91bGQgYmUgY29uc2lzdGVudGx5IGNhc2VkIChsaW5lIDYp",
        "detail": [
          "SW5zdHJ1Y3Rpb25zIHNob3VsZCBiZSBpbiBjb25zaXN0ZW50IGNhc2luZyAoYWxsIGxvd2VyIG9yIGFsbCB1cHBlcik="
        ],
        "url": "https://docs.docker.com/go/dockerfile/rule/consistent-instruction-casing/",
        "sourceInfo": {
          "filename": "Dockerfile",
          "data": "IyBzeW50YXg9ZG9ja2VyL2RvY2tlcmZpbGUtdXBzdHJlYW06bWFzdGVyCmZyT00gYnVzeWJveCBhcyBiYXNlCmNPcHkgRG9ja2VyZmlsZSAuCgpmcm9tIHNjcmF0Y2gKQ09QeSAtLWZyb209YmFzZSBcCiAgL0RvY2tlcmZpbGUgXAogIC8K",
          "definition": {
            "def": [
              "GsUBChJsb2NhbDovL2RvY2tlcmZpbGUSFAoMbG9jYWwuZGlmZmVyEgRub25lEkoKEWxvY2FsLmZvbGxvd3BhdGhzEjVbIkRvY2tlcmZpbGUiLCJEb2NrZXJmaWxlLmRvY2tlcmlnbm9yZSIsImRvY2tlcmZpbGUiXRIqCg1sb2NhbC5zZXNzaW9uEhluOTMwNHpkYzM5Y3B6ajJndjF5MzBicjgwEiEKE2xvY2FsLnNoYXJlZGtleWhpbnQSCmRvY2tlcmZpbGVaAA==",
              "CkkKR3NoYTI1NjoxY2MyNDFmYjIwOGM4N2E0ZjQ4ZTRiZTg5NDY0ZjhiYjI3Nzg2YzYwYTI1NzFmYWY1ZDkxNTg0OTNiNzBhN2U1"
            ],
            "metadata": {
              "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {
                "description": {
                  "llb.customname": "[internal] load build definition from Dockerfile"
                },
                "caps": {
                  "source.local": true,
                  "source.local.followpaths": true,
                  "source.local.sessionid": true,
                  "source.local.sharedkeyhint": true
                }
              },
              "sha256:3e90e4df9cb0f8a6679e7bdf9d853abc823fc04386a4c5c226cea5f7d1bb4ac6": {
                "caps": {
                  "constraints": true,
                  "meta.description": true,
                  "platform": true
                }
              }
            },
            "Source": {
              "locations": {
                "sha256:1cc241fb208c87a4f48e4be89464f8bb27786c60a2571faf5d9158493b70a7e5": {}
              }
            }
          },
          "language": "Dockerfile"
        },
        "range": [
          {
            "start": {
              "line": 6
            },
            "end": {
              "line": 6
            }
          },
          {
            "start": {
              "line": 7
            },
            "end": {
              "line": 7
            }
          },
          {
            "start": {
              "line": 8
            },
            "end": {
              "line": 8
            }
          }
        ]
      }
    ]
  },
  "containerimage.config.digest": "sha256:d0bb2193d26744307a7003c5397e277d1fa73ee979851b0c2ed2afad89d2e44b",
  "containerimage.digest": "sha256:d0bb2193d26744307a7003c5397e277d1fa73ee979851b0c2ed2afad89d2e44b"
}

[crazy-max]

Opened docker/actions-toolkit#362 as follow-up to consume this in our GitHub actions.

Edit: Also docker/actions-toolkit#365 to annotate checks.

[crazy-max]

@tonistiigi Updated to make it opt-in instead.

[tonistiigi]

Sorry, I did not mean combining/replacing this with provenance opt-in when we discussed it. I meant adding another opt-in, similar to what we did with provenance.

[tonistiigi]

I don't think this should be pulled via history API and new progress item added. You can get the warnings by calling printer.Warnings() from command packages.

[crazy-max]

Opened #2551 as alternative

[tonistiigi]

replaced by #2551 ?