Skip to content

Commit b1aa80a

Browse files
committed
ci: require a usable PR description and title
Calls the shared check in imqueue/.github. Generated release notes are built from PR titles and bodies, so a blank template or a title like "V3" silently becomes the changelog for a release. `edited` is in the trigger list so fixing the description clears the failure without pushing a commit. This reports status but does not block merging until it is added as a required status check in branch protection.
1 parent 21f216b commit b1aa80a

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

.github/workflows/pr-quality.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Fails this PR if it has no usable description or its title says nothing.
2+
#
3+
# The rules live in imqueue/.github/.github/workflows/pr-quality.yml. They exist because
4+
# generated release notes are built from PR titles and bodies — see release.yml, which
5+
# creates the GitHub Release page on tag push and cannot invent detail nobody wrote down.
6+
#
7+
# `edited` is in the trigger list on purpose: fixing the description must clear the
8+
# failure without pushing a commit.
9+
10+
name: PR quality
11+
12+
on:
13+
pull_request:
14+
types: [opened, edited, reopened, synchronize]
15+
16+
jobs:
17+
description:
18+
uses: imqueue/.github/.github/workflows/pr-quality.yml@master

0 commit comments

Comments
 (0)