docs: add GitHub Actions section noting git permission workflow updates #37
Workflow file for this run
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: CI | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| pip install . | |
| - name: Run tests | |
| run: | | |
| pytest --maxfail=1 --disable-warnings | |
| tag-version: | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Generate GitHub App token | |
| id: generate_token | |
| uses: tibdex/github-app-token@v2 | |
| with: | |
| app_id: ${{ secrets.HAWKY_APP_ID }} | |
| private_key: ${{ secrets.HAWKY_APP_PRIVATE_KEY }} | |
| - name: Set up git for pushing | |
| run: | | |
| git remote set-url origin https://x-access-token:${{ steps.generate_token.outputs.token }}@github.com/${{ github.repository }}.git | |
| - name: Set git user for HawkyMcBuilderFace bot | |
| run: | | |
| git config user.name "HawkyMcBuilderFace[bot]" | |
| git config user.email "222944+HawkyMcBuilderFace[bot]@users.noreply.github.com" | |
| - name: Get version from pyproject.toml | |
| id: get_version | |
| run: | | |
| VERSION=$(grep '^version = ' pyproject.toml | head -1 | cut -d '"' -f2) | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| - name: Create and push tag for current version | |
| run: | | |
| git tag v${{ steps.get_version.outputs.version }} | |
| git push origin v${{ steps.get_version.outputs.version }} | |
| bump-version: | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| needs: [test, tag-version] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Generate GitHub App token | |
| id: generate_token | |
| uses: tibdex/github-app-token@v2 | |
| with: | |
| app_id: ${{ secrets.HAWKY_APP_ID }} | |
| private_key: ${{ secrets.HAWKY_APP_PRIVATE_KEY }} | |
| - name: Set up git for pushing | |
| run: | | |
| git remote set-url origin https://x-access-token:${{ steps.generate_token.outputs.token }}@github.com/${{ github.repository }}.git | |
| - name: Set git user for HawkyMcBuilderFace bot | |
| run: | | |
| git config user.name "HawkyMcBuilderFace[bot]" | |
| git config user.email "222944+HawkyMcBuilderFace[bot]@users.noreply.github.com" | |
| - name: Bump patch version with bumpver | |
| run: bumpver update --patch --commit | |
| - name: Push version bump commit | |
| run: | | |
| git push |