Skip to content

Commit 81e8be8

Browse files
committed
docs: polish
1 parent 7d15c7f commit 81e8be8

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ If you package an **application** as a Python package, this action is useful to
6363

6464
```yaml
6565
jobs:
66-
check-package:
67-
name: Build & inspect our package.
66+
build-and-inspect-package:
67+
name: Build & inspect package.
6868
runs-on: ubuntu-latest
6969

7070
steps:
@@ -76,8 +76,8 @@ To also upload to PyPI:
7676
7777
```yaml
7878
jobs:
79-
build-package:
80-
name: Build and inspect package.
79+
build-and-inspect-package:
80+
name: Build & inspect package.
8181
runs-on: ubuntu-latest
8282

8383
steps:
@@ -86,8 +86,8 @@ jobs:
8686

8787

8888
upload-to-pypi:
89-
name: Upload prebuilt package to PyPI
90-
needs: build-package
89+
name: Upload package to PyPI
90+
needs: build-and-inspect-package
9191
runs-on: ubuntu-latest
9292
permissions:
9393
# IMPORTANT: this permission is mandatory for trusted publishing, but
@@ -103,6 +103,11 @@ jobs:
103103
- uses: pypa/gh-action-pypi-publish@release/v1
104104
```
105105
106+
> [!IMPORTANT]
107+
> For security reasons, keep the job that has the `id-token: write` permission as short as possible.
108+
109+
---
110+
106111
If you’re using a VCS tag-based version extractor like [*setuptools-scm*] and need the built package to have the correct version, you must use *actions/checkout* with `fetch-depth: 0` – unless the latest commit _is_ the version tag.
107112

108113
> [!CAUTION]

0 commit comments

Comments
 (0)