Refactor the docs to promote user functions #69
Workflow file for this run
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
name: Release | |
on: | |
push: | |
tags: | |
- V* | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
workflow_dispatch: | |
release: | |
types: | |
- published | |
permissions: | |
contents: read | |
# Needed for trusted publishing. | |
id-token: write | |
jobs: | |
pure-python-wheel-and-sdist: | |
name: Build a pure Python wheel and source distribution | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
# Fetch all tags; this is needed for hatch-vcs | |
fetch-depth: 0 | |
- uses: hynek/build-and-inspect-python-package@v1 | |
# Upload to Test PyPI on every commit on main. | |
publish-test-release: | |
name: Publish in-dev package to test.pypi.org | |
environment: publish-test-release | |
if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
runs-on: ubuntu-latest | |
needs: | |
- pure-python-wheel-and-sdist | |
steps: | |
- name: Download packages built by build-and-inspect-python-package | |
uses: actions/download-artifact@v3 | |
with: | |
name: Packages | |
path: dist | |
- name: Upload package to Test PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
repository-url: https://test.pypi.org/legacy/ | |
publish-release: | |
name: Publish release | |
environment: publish-release | |
needs: | |
- pure-python-wheel-and-sdist | |
runs-on: ubuntu-latest | |
if: | | |
(github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || | |
(github.event_name == 'workflow_dispatch' && startsWith(github.event.ref, 'refs/tags')) | |
steps: | |
- uses: actions/download-artifact@v3 | |
with: | |
name: artifacts | |
path: dist | |
- name: Push build artifacts to PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
skip_existing: true | |
user: __token__ | |
password: ${{ secrets.PYPI_API_TOKEN }} |