Skip to content

Commit 4864f13

Browse files
committed
README: use semantic callouts
See: https://github.com/orgs/community/discussions/16925 Signed-off-by: William Woodruff <[email protected]>
1 parent 413a8d5 commit 4864f13

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ tag, or opt-in to [use a full Git commit SHA] and Dependabot.
2525

2626
### Trusted publishing
2727

28-
> **NOTE**: Trusted publishing is sometimes referred to by its
28+
> [!NOTE]
29+
> Trusted publishing is sometimes referred to by its
2930
> underlying technology -- OpenID Connect, or OIDC for short.
3031
> If you see references to "OIDC publishing" in the context of PyPI,
3132
> this is what they're referring to.
@@ -61,10 +62,11 @@ jobs:
6162
uses: pypa/gh-action-pypi-publish@release/v1
6263
```
6364
64-
> **Pro tip**: instead of using branch pointers, like `unstable/v1`, pin
65-
versions of Actions that you use to tagged versions or sha1 commit identifiers.
66-
This will make your workflows more secure and better reproducible, saving you
67-
from sudden and unpleasant surprises.
65+
> [!NOTE]
66+
> Instead of using branch pointers, like `unstable/v1`, pin versions of Actions
67+
> that you use to tagged versions or sha1 commit identifiers.
68+
> This will make your workflows more secure and better reproducible, saving you
69+
> from sudden and unpleasant surprises.
6870

6971
Other indices that support trusted publishing can also be used, like TestPyPI:
7072

@@ -76,7 +78,8 @@ Other indices that support trusted publishing can also be used, like TestPyPI:
7678
```
7779
_(don't forget to update the environment name to `testpypi` or similar!)_
7880

79-
> **Pro tip**: only set the `id-token: write` permission in the job that does
81+
> [!NOTE]
82+
> Only set the `id-token: write` permission in the job that does
8083
> publishing, not globally. Also, try to separate building from publishing
8184
> — this makes sure that any scripts maliciously injected into the build
8285
> or test environment won't be able to elevate privileges while flying under
@@ -96,7 +99,8 @@ This GitHub Action [has nothing to do with _building package
9699
distributions_]. Users are responsible for preparing dists for upload
97100
by putting them into the `dist/` folder prior to running this Action.
98101

99-
> **IMPORTANT**: Since this GitHub Action is docker-based, it can only
102+
> [!IMPORTANT]
103+
> Since this GitHub Action is docker-based, it can only
100104
> be used from within GNU/Linux based jobs in GitHub Actions CI/CD
101105
> workflows. This is by design and is unlikely to change due to a number
102106
> of considerations we rely on.
@@ -187,9 +191,10 @@ default) setting as follows:
187191
skip-existing: true
188192
```
189193

190-
> **Pro tip**: try to avoid enabling this setting where possible. If you
191-
have steps for publishing to both PyPI and TestPyPI, consider only using
192-
it for the latter, having the former fail loudly on duplicates.
194+
> [!NOTE]
195+
> Try to avoid enabling this setting where possible. If you
196+
> have steps for publishing to both PyPI and TestPyPI, consider only using
197+
> it for the latter, having the former fail loudly on duplicates.
193198

194199
### For Debugging
195200

0 commit comments

Comments
 (0)