Skip to content

Commit fbeecf0

Browse files
ramonpetgrave64ramonpetgrave64
committed
update docs
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
1 parent f701310 commit fbeecf0

File tree

14 files changed

+58
-58
lines changed

14 files changed

+58
-58
lines changed

‎BYOB.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ The [slsa-github-generator](https://github.com/slsa-framework/slsa-github-genera
8080
The [setup-generic](https://github.com/slsa-framework/slsa-github-generator/blob/main/actions/delegator/setup-generic) Action is used to initialize the BYOB framework. It returns a so-called "SLSA token" which is used in later steps:
8181

8282
```yaml
83-
- uses: slsa-framework/slsa-github-generator/actions/delegator/setup-generic@v2.0.0
83+
- uses: slsa-framework/slsa-github-generator/actions/delegator/setup-generic@v2.1.0
8484
```
8585

8686
#### SLSA Reusable Workflow (SRW)
8787

8888
The SLSA Reuseable Workflow (SRW) acts as the build's orchestrator. It calls the TCA, generates provenance, and returns the provenance to its TRW caller. A TRW would typically call the SRW as follows:
8989

9090
```yaml
91-
- uses: slsa-framework/slsa-github-generator/.github/workflow/delegator_generic_slsa3.yml@v2.0.0
91+
- uses: slsa-framework/slsa-github-generator/.github/workflow/delegator_generic_slsa3.yml@v2.1.0
9292
with:
9393
slsa-token: ${{ needs.slsa-setup.outputs.slsa-token }}
9494
```
@@ -159,7 +159,7 @@ One key difference between the Action and reusable workflow is isolation. The SR
159159
Our next step is to initialize the SRW framework. To do this, the TRW must invoke the [setup-generic Action](https://github.com/slsa-framework/slsa-github-generator/blob/main/actions/delegator/setup-generic/action.yml). The [relevant code](https://github.com/laurentsimon/byob-doc/blob/v0.0.1/.github/workflows/builder_example_slsa3.yml#L85-L94) calls the SSA as follows:
160160

161161
```yaml
162-
uses: slsa-framework/slsa-github-generator/actions/delegator/setup-generic@v2.0.0
162+
uses: slsa-framework/slsa-github-generator/actions/delegator/setup-generic@v2.1.0
163163
with:
164164
slsa-workflow-recipient: "delegator_generic_slsa3.yml"
165165
slsa-rekor-log-public: ${{ inputs.rekor-log-public }}
@@ -190,7 +190,7 @@ slsa-run:
190190
contents: write # For asset uploads.
191191
packages: write # For package uploads.
192192
actions: read # For the entrypoint.
193-
uses: slsa-framework/slsa-github-generator/.github/workflows/delegator_generic_slsa3.yml@v2.0.0
193+
uses: slsa-framework/slsa-github-generator/.github/workflows/delegator_generic_slsa3.yml@v2.1.0
194194
with:
195195
slsa-token: ${{ needs.slsa-setup.outputs.slsa-token }}
196196
secrets:

‎actions/gradle/publish/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ jobs:
237237
contents: read
238238
actions: read
239239
packages: read
240-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_gradle_slsa3.yml@v2.0.0
240+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_gradle_slsa3.yml@v2.1.0
241241
with:
242242
rekor-log-public: true
243243
artifact-list: build/libs/artifact1-0.1.18.jar,build/libs/artifact-0.1.18-javadoc.jar,build/libs/artifact-0.1.18-sources.jar
@@ -256,7 +256,7 @@ publish:
256256
steps:
257257
- name: publish
258258
id: publish
259-
uses: slsa-framework/slsa-github-generator/actions/gradle/publish@v2.0.0
259+
uses: slsa-framework/slsa-github-generator/actions/gradle/publish@v2.1.0
260260
with:
261261
provenance-download-name: "${{ needs.build.outputs.provenance-download-name }}"
262262
provenance-download-sha256: "${{ needs.build.outputs.provenance-download-sha256 }}"

‎actions/maven/publish/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
id-token: write
2828
contents: read
2929
actions: read
30-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_maven_slsa3.yml@v2.0.0
30+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_maven_slsa3.yml@v2.1.0
3131
with:
3232
rekor-log-public: true
3333
```
@@ -45,7 +45,7 @@ publish:
4545
steps:
4646
- name: publish
4747
id: publish
48-
uses: slsa-framework/slsa-github-generator/actions/maven/publish@v2.0.0
48+
uses: slsa-framework/slsa-github-generator/actions/maven/publish@v2.1.0
4949
with:
5050
provenance-download-name: "${{ needs.build.outputs.provenance-download-name }}"
5151
provenance-download-sha256: "${{ needs.build.outputs.provenance-download-sha256 }}"

‎actions/nodejs/publish/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
contents: read
1919
actions: read
2020
if: startsWith(github.ref, 'refs/tags/')
21-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.0.0
21+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.1.0
2222
with:
2323
run-scripts: "ci, build"
2424

@@ -34,7 +34,7 @@ jobs:
3434

3535
- name: publish
3636
id: publish
37-
uses: slsa-framework/slsa-github-generator/actions/nodejs/publish@v2.0.0
37+
uses: slsa-framework/slsa-github-generator/actions/nodejs/publish@v2.1.0
3838
with:
3939
access: public
4040
node-auth-token: ${{ secrets.NPM_TOKEN }}

‎actions/nodejs/secure-attestations-download/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
contents: read
1616
actions: read
1717
if: startsWith(github.ref, 'refs/tags/')
18-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.0.0
18+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.1.0
1919
with:
2020
run-scripts: "ci, build"
2121

@@ -24,7 +24,7 @@ jobs:
2424
runs-on: ubuntu-latest
2525
steps:
2626
- name: Download provenance
27-
uses: slsa-framework/slsa-github-generator/actions/nodejs/secure-attestations-download@v2.0.0
27+
uses: slsa-framework/slsa-github-generator/actions/nodejs/secure-attestations-download@v2.1.0
2828
with:
2929
name: ${{ needs.build.outputs.provenance-download-name }}
3030
path: "attestations"

‎actions/nodejs/secure-package-download/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
contents: read
1616
actions: read
1717
if: startsWith(github.ref, 'refs/tags/')
18-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.0.0
18+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@v2.1.0
1919
with:
2020
run-scripts: "ci, build"
2121

@@ -24,7 +24,7 @@ jobs:
2424
runs-on: ubuntu-latest
2525
steps:
2626
- name: Download tarball
27-
uses: slsa-framework/slsa-github-generator/actions/nodejs/secure-package-download@v2.0.0
27+
uses: slsa-framework/slsa-github-generator/actions/nodejs/secure-package-download@v2.1.0
2828
with:
2929
name: ${{ needs.build.outputs.package-download-name }}
3030
path: ${{ needs.build.outputs.package-name }}

‎internal/builders/bazel/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ jobs:
8787
contents: read # For repo checkout.
8888
actions: read # For getting workflow run info.
8989
if: startsWith(github.ref, 'refs/tags/')
90-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.0.0
90+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.1.0
9191
with:
9292
targets: "//src:fib //src:hello"
9393
flags: "--strip=always"
@@ -113,7 +113,7 @@ jobs:
113113
contents: read # For repo checkout.
114114
actions: read # For getting workflow run info.
115115
if: startsWith(github.ref, 'refs/tags/')
116-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.0.0
116+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.1.0
117117
with:
118118
targets: "//src:fib //src:hello"
119119
flags: "--strip=always"
@@ -137,7 +137,7 @@ jobs:
137137
contents: read # For repo checkout.
138138
actions: read # For getting workflow run info.
139139
if: startsWith(github.ref, 'refs/tags/')
140-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.0.0
140+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_bazel_slsa3.yml@v2.1.0
141141
with:
142142
targets: "//src:fib //src:hello"
143143
flags: "--strip=always"

‎internal/builders/container/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ provenance:
7373
id-token: write # for creating OIDC tokens for signing.
7474
packages: write # for uploading attestations.
7575
if: startsWith(github.ref, 'refs/tags/')
76-
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.0.0
76+
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.1.0
7777
with:
7878
image: ${{ needs.build.outputs.image }}
7979
digest: ${{ needs.build.outputs.digest }}
@@ -144,7 +144,7 @@ jobs:
144144
id-token: write # for creating OIDC tokens for signing.
145145
packages: write # for uploading attestations.
146146
if: startsWith(github.ref, 'refs/tags/')
147-
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.0.0
147+
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.1.0
148148
with:
149149
image: ${{ needs.build.outputs.image }}
150150
digest: ${{ needs.build.outputs.digest }}
@@ -373,7 +373,7 @@ This section explains how to generate non-forgeable SLSA provenance with existin
373373
# contents: read
374374
packages: write
375375
if: startsWith(github.ref, 'refs/tags/')
376-
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.0.0
376+
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.1.0
377377
with:
378378
image: ${{ needs.build.outputs.image }}
379379
digest: ${{ needs.build.outputs.digest }}
@@ -438,7 +438,7 @@ This section explains how to generate non-forgeable SLSA provenance with existin
438438
# contents: read
439439
packages: write
440440
if: startsWith(github.ref, 'refs/tags/')
441-
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.0.0
441+
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.1.0
442442
with:
443443
image: ${{ needs.build.outputs.image }}
444444
digest: ${{ needs.build.outputs.digest }}

‎internal/builders/docker/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ jobs:
204204
contents: write # To upload assets to release.
205205
actions: read # To read the workflow path.
206206
needs: args
207-
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_container-based_slsa3.yml@v2.0.0
207+
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_container-based_slsa3.yml@v2.1.0
208208
with:
209209
builder-image: "bash"
210210
builder-digest: "sha256:9e2ba52487d945504d250de186cb4fe2e3ba023ed2921dd6ac8b97ed43e76af9"

0 commit comments

Comments
 (0)