keb
0a0a5b88af
Copies `pr-title.yml` from lazysecrets: a pull request title must start with a conventional commit type (`feat: …`, `fix(scope): …`, `[feat] …`). Pull requests are squash-merged, so the title becomes the commit on main. Keeping those conventional means release notes can be written from main's history later (git-cliff, as lazysecrets does). Once merged, `PR title / *` gets added to main's required checks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: #3 Co-authored-by: Karl-Einar Bergstrøm <karl-einarb@outlook.com>
41 lines
1.4 KiB
YAML
41 lines
1.4 KiB
YAML
name: PR title
|
|
|
|
# Pull requests are squash-merged, so the title becomes the commit on main:
|
|
# it must start with a conventional commit type, so that release notes can
|
|
# be written from main's history (git-cliff, as lazysecrets does). Brackets
|
|
# and a missing space are fine too.
|
|
#
|
|
# feat: SOPS and .env files in git repos
|
|
# fix(search): ctrl+r with empty results loads the scope
|
|
# feat!: rename config keys (! marks a breaking change)
|
|
# [feat] install with a one-liner
|
|
# [fix]: hide values on blur
|
|
# docs:split the README
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
types: [opened, edited, reopened, synchronize]
|
|
|
|
jobs:
|
|
title:
|
|
name: Conventional title
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Check the title
|
|
env:
|
|
TITLE: ${{ github.event.pull_request.title }}
|
|
run: |
|
|
types='feat|fix|perf|refactor|docs|test|ci|chore|build|style|revert'
|
|
scope='(\([a-z0-9._/-]+\))?'
|
|
if [[ "$TITLE" =~ ^\[($types)$scope!?\]!?:?[[:space:]]*(.*)$ ]] ||
|
|
[[ "$TITLE" =~ ^($types)$scope!?:[[:space:]]*(.*)$ ]]; then
|
|
what="${BASH_REMATCH[3]}"
|
|
fi
|
|
if [[ "${what:-}" =~ [^[:space:]] ]]; then
|
|
echo "ok: $TITLE"
|
|
else
|
|
echo "::error::The title should start with a type, like \"feat: what changed\" or \"[feat] what changed\"; types: ${types//|/, }. Got: $TITLE"
|
|
exit 1
|
|
fi
|