-
Notifications
You must be signed in to change notification settings - Fork 60.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
python: update PyPI publishing example #32146
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bcc298b
python: update PyPI publishing example
woodruffw 8e443a3
python: markdownlint
woodruffw 3fdab64
python: fixup link
woodruffw 46247d5
python: consistency
woodruffw 7bec6da
python: align with actions/starter-workflows#2345
woodruffw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -392,11 +392,11 @@ jobs: | |||
if: {% raw %}${{ always() }}{% endraw %} | ||||
``` | ||||
|
||||
## Publishing to package registries | ||||
## Publishing to PyPI | ||||
|
||||
You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/repositories/releasing-projects-on-github/managing-releases-in-a-repository). | ||||
You can configure your workflow to publish your Python package to PyPI once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/repositories/releasing-projects-on-github/managing-releases-in-a-repository). | ||||
|
||||
For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions)." | ||||
The example workflow below uses [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) to authenticate with PyPI, eliminating the need for a manually configured API token. | ||||
|
||||
```yaml copy | ||||
{% data reusables.actions.actions-not-certified-by-github-comment %} | ||||
|
@@ -409,25 +409,59 @@ on: | |||
release: | ||||
types: [published] | ||||
|
||||
permissions: | ||||
contents: read | ||||
|
||||
jobs: | ||||
deploy: | ||||
release-build: | ||||
runs-on: ubuntu-latest | ||||
|
||||
steps: | ||||
- uses: {% data reusables.actions.action-checkout %} | ||||
- name: Set up Python | ||||
uses: {% data reusables.actions.action-setup-python %} | ||||
|
||||
- uses: {% data reusables.actions.action-setup-python %} | ||||
with: | ||||
python-version: '3.x' | ||||
- name: Install dependencies | ||||
python-version: "3.x" | ||||
|
||||
- name: Build release distributions | ||||
run: | | ||||
python -m pip install --upgrade pip | ||||
pip install build | ||||
- name: Build package | ||||
run: python -m build | ||||
- name: Publish package | ||||
uses: pypa/gh-action-pypi-publish@release/v1 | ||||
# NOTE: put your own distribution build steps here. | ||||
python -m pip install build | ||||
python -m build | ||||
|
||||
- name: Upload distributions | ||||
uses: {% data reusables.actions.action-upload-artifact %} | ||||
with: | ||||
password: {% raw %}${{ secrets.PYPI_API_TOKEN }}{% endraw %} | ||||
name: release-dists | ||||
path: dist/ | ||||
|
||||
pypi-publish: | ||||
runs-on: ubuntu-latest | ||||
|
||||
needs: | ||||
- release-build | ||||
|
||||
permissions: | ||||
# IMPORTANT: this permission is mandatory for trusted publishing | ||||
id-token: write | ||||
|
||||
# Dedicated environments with protections for publishing are strongly recommended. | ||||
# For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
environment: | ||||
name: pypi | ||||
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status: | ||||
# url: https://pypi.org/p/YOURPROJECT | ||||
|
||||
steps: | ||||
- name: Retrieve release distributions | ||||
uses: {% data reusables.actions.action-download-artifact %} | ||||
with: | ||||
name: release-dists | ||||
path: dist/ | ||||
|
||||
- name: Publish release distributions to PyPI | ||||
uses: pypa/gh-action-pypi-publish@release/v1 | ||||
``` | ||||
|
||||
For more information about the starter workflow, see [`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). | ||||
For more information about this workflow, including the PyPI settings | ||||
needed, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-pypi). | ||||
Comment on lines
-433
to
+467
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. NB: This removes the link to the starter workflow, since it's also currently out-of-date. I'll send a PR updating it as well. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.