diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 7d2d7bc..81e0b6c 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -13,82 +13,114 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v4 - - run: git fetch --prune --unshallow --tags + - run: git fetch --prune --unshallow --tags - - run: pipx install poetry + - run: pipx install poetry - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "3.x" - cache: 'poetry' + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + cache: "poetry" - - run: poetry install + - run: poetry install - - run: poetry self add poetry-version-plugin + - run: poetry self add poetry-version-plugin - - run: poetry build + - run: poetry build - - name: Store the distribution packages - uses: actions/upload-artifact@v4 - with: - name: python-package-distributions - path: dist/ + - name: Store the distribution packages + uses: actions/upload-artifact@v4 + with: + name: python-package-distributions + path: dist/ publish-to-pypi: name: Publish Python 🐍 distribution 📦 to PyPI needs: - - build + - build runs-on: ubuntu-latest environment: name: pypi url: https://pypi.org/p/${{ env.name }} permissions: - id-token: write # IMPORTANT: mandatory for trusted publishing + id-token: write # IMPORTANT: mandatory for trusted publishing steps: - - name: Download all the dists - uses: actions/download-artifact@v4 - with: - name: python-package-distributions - path: dist/ - - name: Publish distribution 📦 to PyPI - uses: pypa/gh-action-pypi-publish@release/v1 + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution 📦 to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 github-release: name: >- Sign the Python 🐍 distribution 📦 with Sigstore and upload them to GitHub Release needs: - - publish-to-pypi + - publish-to-pypi runs-on: ubuntu-latest permissions: - contents: write # IMPORTANT: mandatory for making GitHub Releases - id-token: write # IMPORTANT: mandatory for sigstore + contents: write # IMPORTANT: mandatory for making GitHub Releases + id-token: write # IMPORTANT: mandatory for sigstore steps: - - name: Download all the dists - uses: actions/download-artifact@v4 - with: - name: python-package-distributions - path: dist/ - - name: Sign the dists with Sigstore - uses: sigstore/gh-action-sigstore-python@v2.1.1 - with: - inputs: >- - ./dist/*.tar.gz - ./dist/*.whl - - name: Upload artifact signatures to GitHub Release - env: - GITHUB_TOKEN: ${{ github.token }} - # Upload to GitHub Release using the `gh` CLI. - # `dist/` contains the built packages, and the - # sigstore-produced signatures and certificates. - run: >- - gh release upload - '${{ github.ref_name }}' dist/** - --repo '${{ github.repository }}' + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v2.1.1 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + '${{ github.ref_name }}' dist/** + --repo '${{ github.repository }}' + + publish-docs: + name: Publish documentation 📚 to GitHub Pages + needs: + - github-release + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - run: git fetch --prune --unshallow --tags + + - run: pipx install poetry + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + cache: "poetry" + + - run: poetry install --only doc + + - name: Configure git for gh-pages + run: | + git config --global user.name "SMP Docs Bot" + git config --global user.email "docs@dummy.bot.com" + + - name: Set release version + run: echo "GIT_TAG=${{ github.event.release.tag_name }}" >> $GITHUB_ENV + + - name: Build and deploy documentation + run: poetry run mike deploy --push --update-aliases ${GIT_TAG} latest