Release Notes Generator #5
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 Notes Generator | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| branch: | |
| description: 'Branch to merge release notes into.' | |
| required: true | |
| default: 'main' | |
| version: | |
| description: | |
| 'Version to use for the release. Must be in format: X.Y.Z.' | |
| date: | |
| description: | |
| 'Date of the release. Must be in format YYYY-MM-DD.' | |
| jobs: | |
| releasenotesgeneration: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install requests==2.31.0 | |
| - name: Generate release notes | |
| env: | |
| GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }} | |
| run: > | |
| python scripts/release_notes_generator.py | |
| -v ${{ inputs.version }} | |
| -d ${{ inputs.date }} | |
| - name: Create pull request | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v4 | |
| with: | |
| token: ${{ secrets.GH_ACCESS_TOKEN }} | |
| commit-message: Release notes for v${{ inputs.version }} | |
| author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" | |
| committer: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" | |
| title: v${{ inputs.version }} Release Notes | |
| body: "This is an auto-generated PR to update the release notes." | |
| branch: release-notes | |
| branch-suffix: short-commit-hash | |
| base: ${{ inputs.branch }} |