Publish Python Package #141
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: Publish Python Package | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| publish_release: | |
| description: 'Create Production Release' | |
| required: true | |
| type: boolean | |
| skip_test_pypi: | |
| description: "Skip publishing to test PyPI" | |
| required: false | |
| type: boolean | |
| default: "false" | |
| jobs: | |
| publish: | |
| environment: release | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| contents: write | |
| packages: write | |
| outputs: | |
| pkg_version: ${{ steps.semver.outputs.next }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get Next Version | |
| if: ${{ inputs.publish_release }} | |
| id: semver | |
| uses: ietf-tools/semver-action@v1 | |
| with: | |
| patchList: fix, bugfix, perf, refactor, test, tests, chore, revert | |
| token: ${{ github.token }} | |
| branch: main | |
| - name: Set Next Version Env Var | |
| if: ${{ inputs.publish_release }} | |
| env: | |
| NEXT_VERSION: ${{ steps.semver.outputs.next }} | |
| run: | | |
| echo "NEXT_VERSION=$next" >> $GITHUB_ENV | |
| - name: Create Draft Release | |
| uses: ncipollo/release-action@v1 | |
| if: ${{ inputs.publish_release }} | |
| with: | |
| prerelease: true | |
| draft: false | |
| commit: ${{ github.sha }} | |
| tag: ${{ env.NEXT_VERSION }} | |
| name: ${{ env.NEXT_VERSION }} | |
| body: '*pending*' | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Set Build Variables | |
| run: | | |
| if [[ $NEXT_VERSION ]]; then | |
| echo "Using AUTO SEMVER mode: $NEXT_VERSION" | |
| echo "SHOULD_DEPLOY=true" >> $GITHUB_ENV | |
| echo "PKG_VERSION=$NEXT_VERSION" >> $GITHUB_ENV | |
| echo "PKG_VERSION_STRICT=${NEXT_VERSION#?}" >> $GITHUB_ENV | |
| elif [[ "$GITHUB_REF" =~ ^refs/tags/v* ]]; then | |
| echo "Using TAG mode: $GITHUB_REF_NAME" | |
| echo "SHOULD_DEPLOY=true" >> $GITHUB_ENV | |
| echo "PKG_VERSION=$GITHUB_REF_NAME" >> $GITHUB_ENV | |
| echo "PKG_VERSION_STRICT=${GITHUB_REF_NAME#?}" >> $GITHUB_ENV | |
| else | |
| echo "Using TEST mode: v3.0.0-dev.$GITHUB_RUN_NUMBER" | |
| echo "SHOULD_DEPLOY=false" >> $GITHUB_ENV | |
| echo "PKG_VERSION=v3.0.0-dev.$GITHUB_RUN_NUMBER" >> $GITHUB_ENV | |
| echo "PKG_VERSION_STRICT=3.0.0-dev.$GITHUB_RUN_NUMBER" >> $GITHUB_ENV | |
| fi | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Install Python dependencies | |
| env: | |
| DEBIAN_FRONTEND: noninteractive | |
| run: | | |
| python -m venv venv | |
| source venv/bin/activate | |
| python -m pip install --upgrade pip setuptools wheel twine build | |
| sudo apt update | |
| sudo apt install -y twine | |
| - name: Build Python package | |
| run: | | |
| source venv/bin/activate | |
| echo "Using version $PKG_VERSION_STRICT" | |
| sed -i -r -e "s/^__version__ += '.*'$/__version__ = '$PKG_VERSION_STRICT'/" xml2rfc/__init__.py | |
| python -m build --sdist | |
| - name: Update CHANGELOG | |
| id: changelog | |
| uses: Requarks/changelog-action@v1 | |
| if: env.SHOULD_DEPLOY == 'true' | |
| with: | |
| token: ${{ github.token }} | |
| tag: ${{ env.PKG_VERSION }} | |
| excludeTypes: '' | |
| - name: Commit CHANGELOG.md | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| if: env.SHOULD_DEPLOY == 'true' | |
| with: | |
| branch: main | |
| commit_message: 'docs: update CHANGELOG.md + py file versions for ${{ env.PKG_VERSION }} [skip ci]' | |
| file_pattern: CHANGELOG.md setup.cfg xml2rfc/__init__.py | |
| - name: Create Release | |
| uses: ncipollo/release-action@v1 | |
| if: env.SHOULD_DEPLOY == 'true' | |
| with: | |
| allowUpdates: true | |
| draft: false | |
| tag: ${{ env.PKG_VERSION }} | |
| name: ${{ env.PKG_VERSION }} | |
| body: ${{ steps.changelog.outputs.changes }} | |
| artifacts: "dist/**" | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| makeLatest: true | |
| - name: Publish to Test PyPI | |
| if: ${{ !inputs.skip_test_pypi }} | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| - name: Publish to PyPI | |
| if: env.SHOULD_DEPLOY == 'true' | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| attestations: false | |
| build-base: | |
| runs-on: ubuntu-latest | |
| if: ${{ inputs.publish_release }} | |
| needs: [publish] | |
| permissions: | |
| contents: read | |
| packages: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Docker Build & Push | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| file: docker/base.Dockerfile | |
| platforms: linux/amd64,linux/arm64 | |
| push: true | |
| tags: ghcr.io/ietf-tools/xml2rfc-base:latest |