Skip to content

Commit a5be055

Browse files
committed
readme: outputs docs
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
1 parent a65e1a0 commit a5be055

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ ___
1212
* [Build reusable workflow](#build-reusable-workflow)
1313
* [Inputs](#inputs)
1414
* [Secrets](#secrets)
15+
* [Outputs](#outputs)
1516
* [Bake reusable workflow](#bake-reusable-workflow)
16-
* [Inputs](#inputs)
17-
* [Secrets](#secrets)
17+
* [Inputs](#inputs-1)
18+
* [Secrets](#secrets-1)
19+
* [Outputs](#outputs-1)
1820

1921
## Overview
2022

@@ -252,6 +254,23 @@ on:
252254
| `registry-auths` | | Raw authentication to registries, defined as YAML objects (for `image` output) |
253255
| `github-token` | `${{ github.token }}` | GitHub Token used to authenticate against the repository for Git context |
254256

257+
#### Outputs
258+
259+
These outputs are available as `needs.<job_id>.outputs.*` and can be passed
260+
directly to the [`verify.yml` reusable workflow](.github/workflows/verify.yml)
261+
with `builder-outputs: ${{ toJSON(needs.<job_id>.outputs) }}`.
262+
263+
| Name | Type | Description |
264+
|--------------------------|--------|------------------------------------------------------------------------------|
265+
| `meta-json` | JSON | Metadata JSON output from `docker/metadata-action` (for `image` output) |
266+
| `cosign-version` | String | Cosign version used for verification |
267+
| `cosign-verify-commands` | List | Newline-delimited `cosign verify` commands generated when signing is enabled |
268+
| `artifact-name` | String | Name of the uploaded merged artifact (for `local` output) |
269+
| `image-digest` | String | Digest of the built image manifest (for `image` output when pushed) |
270+
| `image-names` | List | List of image names (for `image` output when pushed) |
271+
| `output-type` | String | Output type selected for the workflow (`image` or `local`) |
272+
| `signed` | Bool | Whether attestation manifests or local artifacts were signed |
273+
255274
### Bake reusable workflow
256275

257276
The [`bake.yml` reusable workflow](.github/workflows/bake.yml) lets you build
@@ -357,3 +376,20 @@ on:
357376
|------------------|-----------------------|--------------------------------------------------------------------------------|
358377
| `registry-auths` | | Raw authentication to registries, defined as YAML objects (for `image` output) |
359378
| `github-token` | `${{ github.token }}` | GitHub Token used to authenticate against the repository for Git context |
379+
380+
#### Outputs
381+
382+
These outputs are available as `needs.<job_id>.outputs.*` and can be passed
383+
directly to the [`verify.yml` reusable workflow](.github/workflows/verify.yml)
384+
with `builder-outputs: ${{ toJSON(needs.<job_id>.outputs) }}`.
385+
386+
| Name | Type | Description |
387+
|--------------------------|--------|------------------------------------------------------------------------------|
388+
| `meta-json` | JSON | Metadata JSON output from `docker/metadata-action` (for `image` output) |
389+
| `cosign-version` | String | Cosign version used for verification |
390+
| `cosign-verify-commands` | List | Newline-delimited `cosign verify` commands generated when signing is enabled |
391+
| `artifact-name` | String | Name of the uploaded merged artifact (for `local` output) |
392+
| `image-digest` | String | Digest of the built image manifest (for `image` output when pushed) |
393+
| `image-names` | List | List of image names (for `image` output when pushed) |
394+
| `output-type` | String | Output type selected for the workflow (`image` or `local`) |
395+
| `signed` | Bool | Whether attestation manifests or local artifacts were signed |

0 commit comments

Comments
 (0)