Release (with Version Bump & Changelog Update) #83
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 (with Version Bump & Changelog Update)" | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| version_number: | |
| description: "Version to bump to: ex. 1.14.5" | |
| required: true | |
| type: string | |
| deploy-to: | |
| type: choice | |
| description: Choose where to publish (test/prod) | |
| options: | |
| - PypiProd | |
| - PypiTest | |
| default: PypiProd | |
| permissions: read-all | |
| defaults: | |
| run: | |
| shell: bash | |
| # will cancel previous workflows triggered by the same event and for the same ref for PRs or same SHA otherwise | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(github.event_name, 'pull_request') && github.event.pull_request.head.ref || github.sha }} | |
| cancel-in-progress: true | |
| jobs: | |
| release-prep: | |
| permissions: | |
| contents: write | |
| name: "Version bump and Changelog update" | |
| uses: ./.github/workflows/pre_release.yml | |
| with: | |
| version_number: ${{ inputs.version_number }} | |
| secrets: | |
| inherit | |
| release: | |
| name: PyPI - ${{ inputs.deploy-to }} | |
| runs-on: ubuntu-latest | |
| needs: [release-prep] | |
| environment: | |
| name: ${{ inputs.deploy-to }} | |
| permissions: | |
| id-token: write # IMPORTANT: this permission is mandatory for trusted publishing | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.ref }} | |
| persist-credentials: false | |
| - name: "Set up Python & Hatch - 3.11" | |
| uses: ./.github/actions/setup-python-hatch | |
| with: | |
| python-version: "3.11" | |
| - name: "Validate version" | |
| run: | | |
| HATCH_VERSION=$(hatch version) | |
| if [[ "${{ inputs.version_number }}" != "$HATCH_VERSION" ]]; then | |
| echo "Version number (${{ inputs.version_number }}) does not match current version ($HATCH_VERSION)" | |
| exit 1 | |
| fi | |
| - name: Build artifacts | |
| run: hatch build | |
| shell: bash | |
| - name: Check artifacts | |
| run: hatch run build:check-all | |
| shell: bash | |
| - name: Publish artifacts to PyPI Test | |
| if: inputs.deploy-to == 'PypiTest' | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| - name: Publish artifacts to PyPI Prod | |
| if: inputs.deploy-to == 'PypiProd' | |
| uses: pypa/gh-action-pypi-publish@release/v1 |