Skip to content

Commit 6fdff4f

Browse files
committed
readme: add section on job summaries
Signed-off-by: David Karlsson <[email protected]>
1 parent 9e59c61 commit 6fdff4f

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

.github/build-push-summary.png

80.6 KB
Loading

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,7 @@ ___
1919
* [Git context](#git-context)
2020
* [Path context](#path-context)
2121
* [Examples](#examples)
22-
* [Multi-platform image](https://docs.docker.com/build/ci/github-actions/multi-platform/)
23-
* [Secrets](https://docs.docker.com/build/ci/github-actions/secrets/)
24-
* [Push to multi-registries](https://docs.docker.com/build/ci/github-actions/push-multi-registries/)
25-
* [Manage tags and labels](https://docs.docker.com/build/ci/github-actions/manage-tags-labels/)
26-
* [Cache management](https://docs.docker.com/build/ci/github-actions/cache/)
27-
* [Export to Docker](https://docs.docker.com/build/ci/github-actions/export-docker/)
28-
* [Test before push](https://docs.docker.com/build/ci/github-actions/test-before-push/)
29-
* [Local registry](https://docs.docker.com/build/ci/github-actions/local-registry/)
30-
* [Share built image between jobs](https://docs.docker.com/build/ci/github-actions/share-image-jobs/)
31-
* [Named contexts](https://docs.docker.com/build/ci/github-actions/named-contexts/)
32-
* [Copy image between registries](https://docs.docker.com/build/ci/github-actions/copy-image-registries/)
33-
* [Update Docker Hub repo description](https://docs.docker.com/build/ci/github-actions/update-dockerhub-desc/)
34-
* [SBOM and provenance attestations](https://docs.docker.com/build/ci/github-actions/attestations/)
35-
* [Annotations](https://docs.docker.com/build/ci/github-actions/annotations/)
36-
* [Reproducible builds](https://docs.docker.com/build/ci/github-actions/reproducible-builds/)
22+
* [Summaries](#summaries)
3723
* [Customizing](#customizing)
3824
* [inputs](#inputs)
3925
* [outputs](#outputs)
@@ -194,6 +180,26 @@ jobs:
194180
* [Annotations](https://docs.docker.com/build/ci/github-actions/annotations/)
195181
* [Reproducible builds](https://docs.docker.com/build/ci/github-actions/reproducible-builds/)
196182

183+
## Summaries
184+
185+
This action generates a [job summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/)
186+
that provides a detailed overview of the build execution. The summary shows an
187+
overview of all the steps executed during the build, including the build inputs
188+
and eventual errors.
189+
190+
![build-push-action job summary](./.github/build-push-summary.png)
191+
192+
The summary also includes a link for downloading the build record with
193+
additional details about the build, including build stats, logs, outputs, and
194+
more. The build record can be imported to Docker Desktop for inspecting the
195+
build in greater detail.
196+
197+
Summaries are enabled by default, but can be disabled with the
198+
`DOCKER_BUILD_NO_SUMMARY` [environment variable](#environment-variables).
199+
200+
For more information about summaries, refer to the
201+
[documentation](https://docs.docker.com/go/build-summary/).
202+
197203
## Customizing
198204

199205
### inputs

0 commit comments

Comments
 (0)