update docs wip #14
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: Chore | |
| on: | |
| pull_request_target: # zizmor: ignore[dangerous-triggers] no PR code executed | |
| branches: [main] | |
| types: [opened, reopened, edited, synchronize] | |
| push: | |
| branches: [main] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| check-pr-title: | |
| name: Check PR Title | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - name: Check valid conventional commit message | |
| id: lint | |
| uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1 | |
| with: | |
| subjectPattern: ^[A-Z].+[^. ]$ # subject must start with uppercase letter and may not end with a dot/space | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Post comment about invalid PR title | |
| if: failure() | |
| uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 | |
| with: | |
| header: conventional-commit-pr-title | |
| message: | | |
| Thank you for opening this pull request! 👋🏼 | |
| This repository requires pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. | |
| <details><summary><b>Details</b></summary> | |
| ``` | |
| ${{ steps.lint.outputs.error_message }} | |
| ``` | |
| ${{ github.event.pull_request.user.login == 'dependabot[bot]' && '*Note: Please manually adjust this for the first few PRs created by dependabot.* It will learn the pattern over time.' || '' }} | |
| </details> | |
| - name: Delete comment about invalid PR title | |
| if: success() | |
| uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 | |
| with: | |
| header: conventional-commit-pr-title | |
| delete: true | |
| release-drafter: | |
| name: ${{ github.event_name == 'pull_request' && 'Assign Labels' || 'Draft Release' }} | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - name: ${{ github.event_name == 'pull_request' && 'Assign labels' || 'Update release draft' }} | |
| uses: release-drafter/release-drafter@6db134d15f3909ccc9eefd369f02bd1e9cffdf97 # v6.2.0 | |
| with: | |
| disable-releaser: ${{ github.event_name == 'pull_request' }} | |
| disable-autolabeler: ${{ github.event_name == 'push' }} | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} |