Skip to content

Commit

Permalink
docs(semantic-pr-footer): Make allowed footers known
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenmathieson authored Jul 22, 2024
1 parent ac46c03 commit 55d6c2e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/actions/semantic-pr-footer-v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,22 @@ jobs:
steps:
- uses: dequelabs/axe-api-team-public/.github/actions/semantic-pr-footer-v1@main
```
## Allowable footers
The footer of a PR will fail unless it [_starts with_ one of the following strings (case insensitive)](https://github.com/dequelabs/axe-api-team-public/blob/main/.github/actions/semantic-pr-footer-v1/src/isValidFooter.ts#L1):
- "close: "
- "closes: "
- "closed: "
- "fix: "
- "fixes: "
- "fixed: "
- "resolve: "
- "resolves: "
- "resolved: "
- "ref: "
- "refs: "
- "qa notes: "
- "no qa required"
- "no qa needed"

0 comments on commit 55d6c2e

Please sign in to comment.