Skip to content

doc: add tag pinning documentation in each builder README #1106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 20, 2022
Merged

doc: add tag pinning documentation in each builder README #1106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
27ba27a
update
laurentsimon Oct 20, 2022
392a04f
update
laurentsimon Oct 20, 2022
5b33f9f
update
laurentsimon Oct 20, 2022
40b62fa
update
laurentsimon Oct 20, 2022
aae2cc9
update
laurentsimon Oct 20, 2022
0aa0c46
Update internal/builders/generic/README.md
laurentsimon Oct 20, 2022
93798ab
Update internal/builders/go/README.md
laurentsimon Oct 20, 2022
2e03c75
update
laurentsimon Oct 20, 2022
b863fdf
Merge branch 'main' into feat/msghashpin
laurentsimon Oct 20, 2022
05122dd
Merge branch 'main' into feat/msghashpin
laurentsimon Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/generate-builder/builder-fetch.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ fi

if [[ "$BUILDER_TAG" != "$(echo -n "$BUILDER_TAG" | grep -P '^v\d*(\.([\d]{1,})){0,2}$')" ]]; then
echo "Invalid builder version: $BUILDER_TAG. Expected version of the form vX.Y.Z"
echo "For details see https://github.com/slsa-framework/slsa-github-generator#verification-of-provenance"
echo "For details see https://github.com/slsa-framework/slsa-github-generator/blob/main/README.md#referencing-slsa-builders-and-generators"
exit 7
fi

Expand Down
7 changes: 7 additions & 0 deletions internal/builders/container/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ project simply generates provenance as a separate step in an existing workflow.
- [Benefits of Provenance](#benefits-of-provenance)
- [Generating Provenance](#generating-provenance)
- [Getting Started](#getting-started)
- [Referencing the SLSA generator](#referencing-the-slsa-generator)
- [Supported Triggers](#supported-triggers)
- [Workflow Inputs](#workflow-inputs)
- [Provenance Format](#provenance-format)
Expand Down Expand Up @@ -148,6 +149,12 @@ jobs:
secrets:
registry-password: ${{ secrets.GITHUB_TOKEN }}
```
### Referencing the SLSA generator

At present, the generator **MUST** be referenced
by a tag of the form `@vX.Y.Z`, because the build will fail if you reference it via a shorter tag like `@vX.Y` or `@vX` or if you reference it by a hash.

For more information about this design decision and how to configure renovatebot,see the main repository [README.md](../../../README.md).

### Supported Triggers

Expand Down
8 changes: 8 additions & 0 deletions internal/builders/generic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ project simply generates provenance as a separate step in an existing workflow.
- [Benefits of Provenance](#benefits-of-provenance)
- [Generating Provenance](#generating-provenance)
- [Getting Started](#getting-started)
- [Referencing the SLSA generator](#referencing-the-slsa-generator)
- [Supported Triggers](#supported-triggers)
- [Workflow Inputs](#workflow-inputs)
- [Workflow Outputs](#workflow-outputs)
Expand Down Expand Up @@ -162,6 +163,13 @@ jobs:
artifact2
```

### Referencing the SLSA generator

At present, the generator **MUST** be referenced
by a tag of the form `@vX.Y.Z`, because the build will fail if you reference it via a shorter tag like `@vX.Y` or `@vX` or if you reference it by a hash.

For more information about this design decision and how to configure renovatebot,see the main repository [README.md](../../../README.md).

### Supported Triggers

The following [GitHub trigger events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows) are fully supported and tested:
Expand Down
8 changes: 8 additions & 0 deletions internal/builders/go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This document explains how to use the builder for [Go](https://go.dev/) projects

[Generation of provenance](#generation)

- [Referencing the SLSA builder](#referencing-the-slsa-builder)
- [Supported Triggers](#supported-triggers)
- [Configuration File](#configuration-file)
- [Migration from GoReleaser](#migration-from-GoReleaser)
Expand All @@ -21,6 +22,13 @@ This document explains how to use the builder for [Go](https://go.dev/) projects
The Go builder workflow uses a GitHub Actions reusable workflow to generate the
provenance.

### Referencing the SLSA builder

At present, the trusted builder **MUST** be referenced
by a tag of the form `@vX.Y.Z`, because the build will fail if you reference it via a shorter tag like `@vX.Y` or `@vX` or if you reference it by a hash.

For more information about this design decision and how to configure renovatebot,see the main repository [README.md](../../../README.md).

### Supported Triggers

The following [GitHub trigger events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows) are fully supported and tested:
Expand Down