Repository navigation
Add GitHub Actions workflow for PyPI publishing #85
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # Build and publish jsonpointer to PyPI when a GitHub release is published. | ||
| # | ||
| # Uses PyPI Trusted Publishing (OIDC), so no API token is stored in GitHub. | ||
| # | ||
| # One-time setup: | ||
| # | ||
| # 1. On PyPI, open https://pypi.org/manage/project/jsonpointer/settings/publishing/ | ||
| # and add a GitHub trusted publisher with: | ||
| # Owner: stefankoegl | ||
| # Repository name: python-json-pointer | ||
| # Workflow name: publish.yml | ||
| # Environment name: pypi | ||
| # | ||
| # 2. In GitHub, go to Settings -> Environments -> New environment and create | ||
| # an environment named "pypi". Optionally add yourself as a required | ||
| # reviewer so every upload needs a manual approval, and restrict | ||
| # deployments to tags (e.g. "v*"). | ||
| # | ||
| # 3. (Optional) Repeat steps 1 and 2 on https://test.pypi.org with the | ||
| # environment name "testpypi" to enable test uploads via manual runs. | ||
| # | ||
| # Releasing: | ||
| # | ||
| # Bump __version__ in jsonpointer.py, commit, tag, push the tag, and publish | ||
| # a GitHub release for that tag. The workflow builds the sdist and wheel and | ||
| # uploads them to PyPI. Running the workflow manually ("Run workflow") uploads | ||
| # to TestPyPI instead. | ||
|
|
||
| name: Publish to PyPI | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build distributions | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.13" | ||
|
|
||
| - name: Install build tools | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install build twine | ||
|
|
||
| - name: Build sdist and wheel | ||
| run: python -m build | ||
|
|
||
| - name: Check distributions | ||
| run: twine check --strict dist/* | ||
|
|
||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: dist | ||
| path: dist/ | ||
|
|
||
| publish-pypi: | ||
| name: Publish to PyPI | ||
| if: github.event_name == 'release' | ||
| needs: [build] | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/project/jsonpointer/ | ||
| permissions: | ||
| id-token: write | ||
| steps: | ||
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: dist | ||
| path: dist/ | ||
|
|
||
| - name: Publish to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
|
|
||
| publish-testpypi: | ||
| name: Publish to TestPyPI | ||
| if: github.event_name == 'workflow_dispatch' | ||
| needs: [build] | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: testpypi | ||
| url: https://test.pypi.org/project/jsonpointer/ | ||
| permissions: | ||
| id-token: write | ||
| steps: | ||
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: dist | ||
| path: dist/ | ||
|
|
||
| - name: Publish to TestPyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| with: | ||
| repository-url: https://test.pypi.org/legacy/ | ||
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.
Uh oh!
There was an error while loading. Please reload this page.