Release #7
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
| name: Release | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| bump: | |
| description: 'Version bump (ignored for testpypi)' | |
| required: true | |
| type: choice | |
| options: | |
| - patch | |
| - minor | |
| - major | |
| - stable | |
| - 'no' | |
| prerelease: | |
| description: 'Prerelease type (ignored for testpypi)' | |
| required: true | |
| default: 'no' | |
| type: choice | |
| options: | |
| - 'no' | |
| - alpha | |
| - beta | |
| - rc | |
| target: | |
| description: 'Publish target' | |
| required: true | |
| default: 'testpypi' | |
| type: choice | |
| options: | |
| - testpypi | |
| - pypi | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| jobs: | |
| prepare-version: | |
| name: Prepare version | |
| runs-on: ubuntu-latest | |
| outputs: | |
| version: ${{ steps.version.outputs.version }} | |
| commit_sha: ${{ steps.version.outputs.commit_sha }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| - name: Set version | |
| id: version | |
| run: | | |
| if [ "${{ inputs.target }}" = "testpypi" ]; then | |
| # For TestPyPI: use current version + .dev suffix (no commit) | |
| CURRENT=$(uv version --short) | |
| VERSION="${CURRENT}.dev${{ github.run_number }}" | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| echo "commit_sha=${{ github.sha }}" >> $GITHUB_OUTPUT | |
| else | |
| # For PyPI: bump version and commit | |
| BUMP="${{ inputs.bump }}" | |
| PRERELEASE="${{ inputs.prerelease }}" | |
| if [ "$BUMP" = "stable" ]; then | |
| # Promote prerelease to stable | |
| uv version --bump stable | |
| elif [ "$BUMP" = "no" ] && [ "$PRERELEASE" = "no" ]; then | |
| echo "Error: Must specify either a version bump or prerelease type" | |
| exit 1 | |
| elif [ "$BUMP" = "no" ]; then | |
| # Prerelease-only bump (a1→a2, rc1→rc2) | |
| uv version --bump "$PRERELEASE" | |
| elif [ "$PRERELEASE" = "no" ]; then | |
| # Stable version bump | |
| uv version --bump "$BUMP" | |
| else | |
| # Version bump + prerelease (0.1.0 → 0.1.1a1) | |
| uv version --bump "$BUMP" --bump "$PRERELEASE" | |
| fi | |
| VERSION=$(uv version --short) | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| # Commit via API (signed) | |
| PYPROJECT_CONTENT=$(base64 -w 0 pyproject.toml) | |
| PYPROJECT_SHA=$(gh api repos/${{ github.repository }}/git/blobs \ | |
| -f content="$PYPROJECT_CONTENT" \ | |
| -f encoding=base64 \ | |
| --jq '.sha') | |
| TREE_SHA=$(gh api repos/${{ github.repository }}/git/trees \ | |
| -f base_tree="${{ github.sha }}" \ | |
| -f 'tree[][path]=pyproject.toml' \ | |
| -f 'tree[][mode]=100644' \ | |
| -f 'tree[][type]=blob' \ | |
| -f "tree[][sha]=$PYPROJECT_SHA" \ | |
| --jq '.sha') | |
| COMMIT_SHA=$(gh api repos/${{ github.repository }}/git/commits \ | |
| -f message="Bump version to $VERSION [skip ci]" \ | |
| -f tree="$TREE_SHA" \ | |
| -f "parents[]=${{ github.sha }}" \ | |
| --jq '.sha') | |
| gh api repos/${{ github.repository }}/git/refs/heads/${{ github.ref_name }} \ | |
| -X PATCH \ | |
| -f sha="$COMMIT_SHA" | |
| echo "commit_sha=$COMMIT_SHA" >> $GITHUB_OUTPUT | |
| fi | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| build: | |
| name: Build distribution | |
| needs: [prepare-version] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ needs.prepare-version.outputs.commit_sha }} | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| - name: Set dev version for TestPyPI | |
| if: inputs.target == 'testpypi' | |
| run: uv version "${{ needs.prepare-version.outputs.version }}" | |
| - name: Build sdist and wheel | |
| run: uv build | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| publish-testpypi: | |
| name: Publish to TestPyPI | |
| needs: [prepare-version, build] | |
| runs-on: ubuntu-latest | |
| if: inputs.target == 'testpypi' | |
| environment: | |
| name: testpypi | |
| url: https://test.pypi.org/project/kdbxtool/ | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download artifacts | |
| 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/ | |
| publish-pypi: | |
| name: Publish to PyPI | |
| needs: [prepare-version, build] | |
| runs-on: ubuntu-latest | |
| if: inputs.target == 'pypi' | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/project/kdbxtool/ | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| create-release: | |
| name: Create GitHub Release | |
| needs: [prepare-version, publish-pypi] | |
| runs-on: ubuntu-latest | |
| if: inputs.target == 'pypi' | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist | |
| - name: Create release | |
| run: | | |
| VERSION="${{ needs.prepare-version.outputs.version }}" | |
| if echo "$VERSION" | grep -qE '(a|b|rc)[0-9]+'; then | |
| gh release create "v$VERSION" dist/* --repo ${{ github.repository }} --generate-notes --prerelease | |
| else | |
| gh release create "v$VERSION" dist/* --repo ${{ github.repository }} --generate-notes | |
| fi | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| deploy-versioned-docs: | |
| name: Deploy versioned docs | |
| needs: [prepare-version, create-release] | |
| runs-on: ubuntu-latest | |
| if: inputs.target == 'pypi' | |
| environment: | |
| name: github-pages | |
| concurrency: | |
| group: docs | |
| cancel-in-progress: false | |
| steps: | |
| - name: Download existing pages | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| # Get the latest pages artifact | |
| ARTIFACT_ID=$(gh api repos/${{ github.repository }}/actions/artifacts \ | |
| --jq '[.artifacts[] | select(.name == "github-pages")] | first | .id') | |
| if [ -z "$ARTIFACT_ID" ] || [ "$ARTIFACT_ID" = "null" ]; then | |
| echo "No existing pages found" | |
| exit 1 | |
| fi | |
| gh api repos/${{ github.repository }}/actions/artifacts/$ARTIFACT_ID/zip > pages.zip | |
| unzip pages.zip -d pages_tar/ | |
| mkdir -p deploy | |
| tar -xf pages_tar/artifact.tar -C deploy/ | |
| - name: Copy latest to versioned | |
| run: | | |
| VERSION="${{ needs.prepare-version.outputs.version }}" | |
| cp -r deploy/latest "deploy/$VERSION" | |
| - name: Update versions.json | |
| run: | | |
| VERSION="${{ needs.prepare-version.outputs.version }}" | |
| # Add new version to the list (after latest, before other versions) | |
| jq --arg v "$VERSION" --arg name "v$VERSION" \ | |
| 'if any(.version == $v) then . else [.[0]] + [{"name": $name, "version": $v}] + .[1:] end' \ | |
| deploy/versions.json > deploy/versions.json.new | |
| mv deploy/versions.json.new deploy/versions.json | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: deploy/ | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@v4 |