docs(#618): add error states and validation patterns checklist (#684) #61
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: Generate Changelog | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v*' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| changelog: | |
| name: Generate changelog | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Generate a changelog | |
| uses: orhun/git-cliff-action@v4 | |
| with: | |
| config: cliff.toml | |
| args: --verbose | |
| env: | |
| OUTPUT: docs/changelog.md | |
| GITHUB_REPO: ${{ github.repository }} | |
| - name: Ensure GH_PAT is configured | |
| env: | |
| GH_PAT: ${{ secrets.GH_PAT }} | |
| run: | | |
| if [ -z "$GH_PAT" ]; then | |
| echo "GH_PAT secret is required to create changelog pull requests." | |
| exit 1 | |
| fi | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v6 | |
| with: | |
| token: ${{ secrets.GH_PAT }} | |
| commit-message: "chore(changelog): update changelog" | |
| title: "chore(changelog): Update Changelog" | |
| body: | | |
| Automated changelog generation using git-cliff. | |
| **Maintainer Action Required:** | |
| Please review the generated `docs/changelog.md` and inject any necessary migration guides or editorial notes before merging this PR. | |
| branch: update-changelog | |
| base: main |