Skip to content

Commit a945c96

Browse files
authored
docs: link to our config file for conventional commits warning (ibis-project#10986)
If you mess this up and get the warning, it isn't very acitonable. I then have to remember where to go look up the spec. If you have suggestions on how else to make this more actionable, let me know!
1 parent 2ee6a91 commit a945c96

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

.github/workflows/pr-title.yml

+17-3
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,15 @@ jobs:
3030
id: lint
3131
run: |
3232
failed=0
33-
if ! npx commitlint --extends "@commitlint/config-conventional" --verbose <<< "$COMMIT_MSG"; then
34-
failed=1
33+
if ! lint_output=$(npx commitlint --extends "@commitlint/config-conventional" --verbose <<< "$COMMIT_MSG" 2>&1); then
34+
failed=1
3535
fi
36-
echo "failed=$failed" >> "$GITHUB_OUTPUT"
36+
{
37+
echo "failed=$failed"
38+
echo "lint_output<<EOF"
39+
echo "$lint_output"
40+
echo "EOF"
41+
} >> "$GITHUB_OUTPUT"
3742
env:
3843
COMMIT_MSG: |
3944
${{ github.event.pull_request.title }}
@@ -62,6 +67,15 @@ jobs:
6267
6368
Please update your PR title and description to match the specification.
6469
70+
See https://github.com/ibis-project/ibis/blob/main/.releaserc.js
71+
for the list of acceptable prefixes, eg "feat:", "fix:", "chore:", etc.
72+
73+
The commitlint output is:
74+
75+
```
76+
${{ steps.lint.outputs.lint_output }}
77+
```
78+
6579
- name: fail the check if commitlint failed
6680
if: steps.lint.outputs.failed == '1'
6781
run: exit 1 # templating not allowed here it seems

0 commit comments

Comments
 (0)