docs: make doc-comment summaries rustdoc-first #7
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
| # Validates that every pull request title follows Conventional Commits | |
| # (https://www.conventionalcommits.org). PRs are squash-merged, so the title | |
| # becomes the commit message on `main`, and release-plz reads it to derive the | |
| # version bump and changelog — a malformed title would silently break releases. | |
| # | |
| # WIP support: prefix a title with "[WIP] " to mark a PR as in progress. The | |
| # action then reports the "action-semantic-pull-request" commit status as | |
| # *pending* (instead of failing the title check), so the PR can't be merged | |
| # until you drop the prefix and give it a real type. GitHub draft PRs do the | |
| # same job if you prefer. To actually block the merge, add that status to your | |
| # branch protection's required checks. | |
| # | |
| # Runs on pull_request_target so it also works for PRs from forks: the token is | |
| # writable in the base context, which the pending-status feature needs. The | |
| # token reads the title from the event payload and writes the commit status, | |
| # but no PR code is ever checked out or executed — that's what makes the | |
| # elevated trigger safe. | |
| name: PR title | |
| # No workflow-level grants: the validate job below declares exactly what it needs. | |
| permissions: {} | |
| on: | |
| pull_request_target: | |
| types: [opened, edited, reopened, synchronize] | |
| concurrency: | |
| group: pr-title-${{ github.event.pull_request.number }} | |
| cancel-in-progress: true | |
| jobs: | |
| validate: | |
| name: Validate PR title | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| permissions: | |
| pull-requests: read # read the PR title | |
| statuses: write # report the pending status for [WIP] titles | |
| steps: | |
| # Types default to the Conventional Commits set, which is exactly what | |
| # release-plz expects, so we only opt into the [WIP] prefix here. | |
| - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| wip: true |