Skip to content

Commit 9bd3572

Browse files
committed
attestations: document in README.md
1 parent 85dbf7c commit 9bd3572

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,25 @@ for example. See [Creating & using secrets]. While still secure,
246246
[trusted publishing] is now encouraged over API tokens as a best practice
247247
on supported platforms (like GitHub).
248248

249+
### Generating and uploading attestations (EXPERIMENTAL)
250+
251+
> [!NOTE]
252+
> Support for generating and uploading [PEP 740 attestations] is currently
253+
> experimental and limited only to Trusted Publishing flows using PyPI or TestPyPI.
254+
255+
You can generate signed [PEP 740 attestations] for all the distribution files and
256+
upload them all together by enabling the `attestations` setting:
257+
258+
```yml
259+
with:
260+
attestations: true
261+
```
262+
263+
This will use `sigstore` to create attestation objects for each distribution package,
264+
signing them with the identity provided by the GitHub's OIDC token associated with the
265+
current workflow. This means both the trusted publishing authentication and the
266+
attestations are tied to the same identity.
267+
249268
## License
250269

251270
The Dockerfile and associated scripts and documentation in this project
@@ -287,3 +306,5 @@ https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
287306
[configured on PyPI]: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
288307

289308
[how to specify username and password]: #specifying-a-different-username
309+
310+
[PEP 740 attestations]: https://peps.python.org/pep-0740/

0 commit comments

Comments
 (0)