docs: split the reference out of the README into docs/ #8
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
| name: PR title | |
| # The PR title becomes the squashed commit message, and release-please derives the | |
| # next version from it. A title that does not parse means a release that silently | |
| # does not happen, so it is validated before merge rather than discovered after. | |
| on: | |
| pull_request_target: | |
| types: [opened, edited, synchronize, reopened] | |
| permissions: | |
| pull-requests: read | |
| jobs: | |
| conventional-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: amannn/action-semantic-pull-request@v6 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # feat -> minor, fix/perf -> patch, feat! or a BREAKING CHANGE footer -> major. | |
| # The rest are patch-or-nothing and never drive a release on their own. | |
| types: | | |
| feat | |
| fix | |
| perf | |
| refactor | |
| docs | |
| test | |
| build | |
| ci | |
| chore | |
| revert | |
| # Optional, but keep the vocabulary small so it stays meaningful. A scope is | |
| # not required, but any scope used must appear here. | |
| # | |
| # 'master' is not a component — it is the branch name release-please puts in | |
| # its own PR title ("chore(master): release 2.1.0"). Without it that title | |
| # fails this check, and once the check is required by a branch ruleset the | |
| # release PR becomes unmergeable. | |
| scopes: | | |
| lua | |
| napi | |
| build | |
| vendor | |
| lfs | |
| deps | |
| docs | |
| release | |
| master | |
| requireScope: false | |
| # Only the trailing full stop is rejected. A lower-case rule is deliberately | |
| # not used: Dependabot capitalises some of its titles ("Bump x from 1 to 2") | |
| # and not others, so it fails dependency PRs for a reason unrelated to | |
| # anything a human chose. | |
| subjectPattern: ^(?!.*\.$).+$ | |
| subjectPatternError: | | |
| The subject "{subject}" must not end with a full stop, e.g. | |
| "fix(lua): resolve the stack index before pushing". |