Skip to content

Commit d7f3007

Browse files
authored
fix: replace job_workflow_ref with workflow_ref (#57)
TL;DR: `job_workflow_ref` and `workflow_ref` are *often* the same thing and have the same value, but sometimes diverge in ways that make later support for GitHub's reusable workflows difficult. This guide should recommend `workflow_ref` instead of `job_workflow_ref` for the "baseline" of Trusted Publishing, since it's always correct as the "initiating" workflow identity. See pypi/warehouse#11096 and rust-lang/crates.io#11131 (comment) for more context. Signed-off-by: William Woodruff <[email protected]>
1 parent bc8c93c commit d7f3007

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/trusted-publishers-for-all-package-repositories.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For some Trusted Publishing providers, Trusted Publishers allow binding verifiab
2020

2121
Trusted Publishers are ideal for package repositories that accept user-built packages, like PyPI and RubyGems, as opposed to package repositories that have centralized build infrastructure like Homebrew.
2222

23-
Trusted Publishers pairs well with other technologies such as SLSA build provenance, as it is built on the same underlying technology, the OIDC standard.
23+
Trusted Publishers pairs well with other technologies such as SLSA build provenance, as it is built on the same underlying technology, the OIDC standard.
2424

2525
Package repositories which don’t host separate artifacts (such as pkg.go.dev) don’t require authenticating with the repository, thus Trusted Publishers isn’t applicable.
2626

@@ -46,7 +46,7 @@ A high-level overview of how PyPI verifies the OIDC ID token against a pre-confi
4646
* `repository` is `example-repo`
4747
* `repository_owner` is `example-owner`
4848
* `repository_owner_id` is `12345`
49-
* `job_workflow_ref` is `example-owner/example-repo/.github/workflows/publish.yml@abcdef`
49+
* `workflow_ref` is `example-owner/example-repo/.github/workflows/publish.yml@abcdef`
5050

5151
Once this is complete, the package repository can authorize publications by delegating to a repository-managed token.
5252

@@ -123,4 +123,4 @@ As of April 2024, the [Python Package Index](https://blog.pypi.org/posts/2023-04
123123

124124
* [https://docs.pypi.org/trusted-publishers/internals/](https://docs.pypi.org/trusted-publishers/internals/)
125125
* [https://docs.pypi.org/trusted-publishers/security-model/](https://docs.pypi.org/trusted-publishers/security-model/)
126-
* [https://docs.google.com/presentation/d/e/2PACX-1vTJ2k4yr4tzug5Nf4HIrJ9Am2vMX2I1b0wUlreDPZc2dbWow9SRm78fmuvlyhEggtdk1Mefme3nmtd_/pub](https://docs.google.com/presentation/d/e/2PACX-1vTJ2k4yr4tzug5Nf4HIrJ9Am2vMX2I1b0wUlreDPZc2dbWow9SRm78fmuvlyhEggtdk1Mefme3nmtd_/pub)
126+
* [https://docs.google.com/presentation/d/e/2PACX-1vTJ2k4yr4tzug5Nf4HIrJ9Am2vMX2I1b0wUlreDPZc2dbWow9SRm78fmuvlyhEggtdk1Mefme3nmtd_/pub](https://docs.google.com/presentation/d/e/2PACX-1vTJ2k4yr4tzug5Nf4HIrJ9Am2vMX2I1b0wUlreDPZc2dbWow9SRm78fmuvlyhEggtdk1Mefme3nmtd_/pub)

0 commit comments

Comments
 (0)