diff --git a/.github/bake-summary.png b/.github/bake-summary.png new file mode 100644 index 0000000..2e25245 Binary files /dev/null and b/.github/bake-summary.png differ diff --git a/README.md b/README.md index 959ae59..669d9e3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ ___ * [Usage](#usage) * [Path context](#path-context) * [Git context](#git-context) +* [Summaries](#summaries) * [Customizing](#customizing) * [inputs](#inputs) * [outputs](#outputs) @@ -138,6 +139,26 @@ another private repository for remote definitions, you can set the BUILDX_BAKE_GIT_AUTH_TOKEN: ${{ secrets.MYTOKEN }} ``` +## Summaries + +This action generates a [job summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/) +that provides a detailed overview of the build execution. The summary shows an +overview of all the steps executed during the build, including the build +inputs, bake definition, and eventual errors. + +![build-push-action job summary](./.github/bake-summary.png) + +The summary also includes a link for downloading a build record archive with +additional details about the build execution for all the bake targets, +including build stats, logs, outputs, and more. The build record can be +imported to Docker Desktop for inspecting the build in greater detail. + +Summaries are enabled by default, but can be disabled with the +`DOCKER_BUILD_NO_SUMMARY` [environment variable](#environment-variables). + +For more information about summaries, refer to the +[documentation](https://docs.docker.com/go/build-summary/). + ## Customizing ### inputs