Skip to content

Commit dd8803d

Browse files
caleb2hedfams
caleb2h
authored and
edfams
committed
Fix workflows to only check new PR commits, not historical ones (#5)
1 parent aca15bd commit dd8803d

File tree

4 files changed

+108
-42
lines changed

4 files changed

+108
-42
lines changed

‎.github/workflows/enforce-pr-number.yml‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
name: Enforce PR Number in Commits
22

3+
# This workflow only checks NEW commits that are part of the PR
4+
# It does not check historical commits that might already be in the base branch
35
on:
46
pull_request:
57
types: [opened, edited, synchronize]
@@ -27,12 +29,20 @@ jobs:
2729
const prNumber = context.payload.pull_request.number;
2830
const baseBranch = context.payload.pull_request.base.ref;
2931
30-
// Get commits in this PR
31-
const commits = await github.rest.pulls.listCommits({
32-
owner: context.repo.owner,
33-
repo: context.repo.repo,
34-
pull_number: prNumber
35-
});
32+
// Get commits in this PR - this API only returns commits unique to the PR
33+
let commits;
34+
try {
35+
commits = await github.rest.pulls.listCommits({
36+
owner: context.repo.owner,
37+
repo: context.repo.repo,
38+
pull_number: prNumber
39+
});
40+
} catch (error) {
41+
console.log('::error::Failed to fetch PR commits. Falling back to simple check.');
42+
console.log('Error:', error.message);
43+
// Exit gracefully if we can't access commits
44+
return;
45+
}
3646
3747
let hasIssues = false;
3848
const problematicCommits = [];
@@ -90,13 +100,17 @@ jobs:
90100
}
91101
});
92102
93-
// Add label to PR
94-
await github.rest.issues.addLabels({
95-
owner: context.repo.owner,
96-
repo: context.repo.repo,
97-
issue_number: prNumber,
98-
labels: ['needs-pr-number']
99-
});
103+
// Try to add label, but don't fail if we can't
104+
try {
105+
await github.rest.issues.addLabels({
106+
owner: context.repo.owner,
107+
repo: context.repo.repo,
108+
issue_number: prNumber,
109+
labels: ['needs-pr-number']
110+
});
111+
} catch (e) {
112+
console.log('::warning::Could not add label (insufficient permissions)');
113+
}
100114
} else {
101115
// Remove label if it exists
102116
try {

‎.github/workflows/pr-format-simple.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: PR Format Check (Simple)
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize]
6+
7+
jobs:
8+
check-commits:
9+
name: Check Commit Format
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Check commit messages for PR number
19+
run: |
20+
PR_NUMBER=${{ github.event.pull_request.number }}
21+
BASE_REF=${{ github.event.pull_request.base.ref }}
22+
23+
echo "Checking commits for PR #${PR_NUMBER}"
24+
echo "Base branch: ${BASE_REF}"
25+
26+
# Fetch the base branch to ensure we have it
27+
git fetch origin ${BASE_REF}
28+
29+
# Get only the commits that are unique to this PR
30+
COMMITS=$(git rev-list origin/${BASE_REF}..HEAD)
31+
32+
if [ -z "$COMMITS" ]; then
33+
echo "No new commits found in this PR"
34+
exit 0
35+
fi
36+
37+
MISSING_PR_NUMBER=false
38+
echo ""
39+
echo "New commits in this PR:"
40+
echo "======================"
41+
42+
for commit in $COMMITS; do
43+
MESSAGE=$(git log -1 --pretty=%s $commit)
44+
SHA_SHORT=$(echo $commit | cut -c1-7)
45+
46+
# Check if this commit already has ANY PR number (it might be from another PR)
47+
if echo "$MESSAGE" | grep -q "(#[0-9]\+)$"; then
48+
echo "✅ ${SHA_SHORT}: ${MESSAGE}"
49+
else
50+
echo "❌ ${SHA_SHORT}: ${MESSAGE}"
51+
echo " Missing PR number - should end with (#${PR_NUMBER})"
52+
MISSING_PR_NUMBER=true
53+
fi
54+
done
55+
56+
echo ""
57+
if [ "$MISSING_PR_NUMBER" = true ]; then
58+
echo "::error::Some commits are missing PR numbers. Please add (#${PR_NUMBER}) to commit messages."
59+
echo ""
60+
echo "To fix this, run:"
61+
echo " ./scripts/add-pr-number.sh ${PR_NUMBER}"
62+
echo "or:"
63+
echo " git rebase origin/${{ github.event.pull_request.base.ref }} --exec 'git commit --amend -m \"\$(git log -1 --pretty=%s) (#${PR_NUMBER})\"'"
64+
echo " git push --force-with-lease"
65+
exit 1
66+
else
67+
echo "::notice::All commits have PR numbers ✅"
68+
fi

‎.github/workflows/pr-title-check.yml‎

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,31 +30,9 @@ jobs:
3030
// Suggest adding PR number
3131
const suggestedTitle = `${prTitle} (#${prNumber})`;
3232
33-
const comment = `## 📝 PR Title Suggestion
33+
// Simply log the suggestion instead of creating a comment
34+
console.log(`::notice title=PR Title Suggestion::Consider updating PR title to: ${suggestedTitle}`);
3435
35-
For better commit history when using "Rebase and merge", consider updating your PR title to:
36-
37-
**${suggestedTitle}**
38-
39-
This ensures the PR number is included in the commit message.`;
40-
41-
// Check if we already commented
42-
const comments = await github.rest.issues.listComments({
43-
owner: context.repo.owner,
44-
repo: context.repo.repo,
45-
issue_number: prNumber
46-
});
47-
48-
const botComment = comments.data.find(comment =>
49-
comment.user.type === 'Bot' &&
50-
comment.body.includes('PR Title Suggestion')
51-
);
52-
53-
if (!botComment) {
54-
await github.rest.issues.createComment({
55-
owner: context.repo.owner,
56-
repo: context.repo.repo,
57-
issue_number: prNumber,
58-
body: comment
59-
});
60-
}
36+
// Set output for other steps to use
37+
core.setOutput('suggested_title', suggestedTitle);
38+
core.setOutput('needs_pr_number', 'true');

‎scripts/add-pr-number.sh‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,14 @@ echo "Adding (#$PR_NUMBER) to commits since $BASE_BRANCH"
2020
echo ""
2121

2222
# Show commits that will be modified
23-
echo "Commits to be updated:"
24-
git log --oneline $BASE_BRANCH..HEAD
23+
echo "New commits in this branch (will add PR number to these):"
24+
git log --oneline $BASE_BRANCH..HEAD | while read line; do
25+
if echo "$line" | grep -q "(#[0-9]\+)$"; then
26+
echo " ✓ $line (already has PR number)"
27+
else
28+
echo " → $line"
29+
fi
30+
done
2531
echo ""
2632

2733
read -p "Continue? (y/n) " -n 1 -r

0 commit comments

Comments
 (0)