Skip to content

Commit 6b2a6d4

Browse files
ooplesclaude
ooples
and
claude
authored
ci: add auto-fix workflow for failing commit messages (#532)
* ci: add auto-fix workflow for failing commit messages Add a github actions workflow that automatically fixes commit messages when the commitlint check fails. the workflow: - triggers when the "commit message lint" workflow fails on a pr - squashes multiple commits into one using the pr title as the message - amends single commits to use the pr title as the message - force pushes the fixed commits to the pr branch - posts a comment explaining the fix this works in conjunction with the existing pr-title-lint.yml which auto-fixes pr titles to follow conventional commits format. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address copilot review comments in commitlint-autofix workflow - Add conditional to force push step to only run when changes were made - Add conditional to PR comment step to avoid posting when no changes made - Improve error message when no PR found with diagnostic information - Fix body extraction to skip blank line separator (tail -n +3) - Trim whitespace from body content before checking if non-empty - Use force-with-lease with specific SHA for safer force pushing - Fix indentation in PR comment message strings 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address yaml linting and remove tests from release pipeline - Replace colons with em-dashes in PR comment template strings to satisfy actionlint and yamllint parsers - Remove test jobs from automated-release.yml since tests are already required to pass before PRs can be merged - This speeds up releases and avoids SDK version conflicts in CI 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 794066d commit 6b2a6d4

2 files changed

Lines changed: 204 additions & 64 deletions

File tree

‎.github/workflows/automated-release.yml‎

Lines changed: 6 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -208,74 +208,16 @@ jobs:
208208
if: steps.version.outputs.should_release == 'true'
209209
run: dotnet build -c Release --no-restore
210210

211-
# Parallel test execution - 3 shards running simultaneously
212-
# Each shard builds independently but uses cached NuGet packages
213-
# Tests run on net8.0 only for speed (net471 verified in pack step)
214-
test:
215-
name: Test (${{ matrix.project }})
216-
runs-on: ubuntu-latest
217-
needs: version-and-build
218-
timeout-minutes: 30
219-
if: needs.version-and-build.outputs.should_release == 'true'
220-
strategy:
221-
fail-fast: false
222-
matrix:
223-
project:
224-
- tests/AiDotNet.Tests/AiDotNetTests.csproj
225-
- tests/AiDotNet.Serving.Tests/AiDotNet.Serving.Tests.csproj
226-
- tests/AiDotNet.Tensors.Tests/AiDotNet.Tensors.Tests.csproj
227-
steps:
228-
- name: Checkout code
229-
uses: actions/checkout@v6
230-
231-
- name: Setup .NET
232-
uses: actions/setup-dotnet@v5
233-
with:
234-
dotnet-version: 8.0.x
211+
# NOTE: Tests are NOT run in the release pipeline because:
212+
# 1. Tests are already required to pass before PRs can be merged
213+
# 2. This avoids duplicate test runs and speeds up releases
214+
# 3. SDK version conflicts between CI runners and project requirements are avoided
235215

236-
- name: Cache NuGet packages
237-
uses: actions/cache@v4
238-
with:
239-
path: ~/.nuget/packages
240-
key: nuget-${{ runner.os }}-${{ hashFiles('**/*.csproj', '**/Directory.Build.props') }}
241-
restore-keys: |
242-
nuget-${{ runner.os }}-
243-
244-
- name: Restore dependencies
245-
run: dotnet restore
246-
247-
- name: Build
248-
run: dotnet build -c Release --no-restore
249-
250-
# Run tests with detailed logging
251-
# net8.0 only for CI speed - net471 compatibility verified in pack step
252-
# GPU tests are quarantined (require physical GPU hardware not available in CI)
253-
# Integration tests are skipped (timing-dependent tests unreliable in CI)
254-
- name: Run tests for ${{ matrix.project }}
255-
run: |
256-
PROJECT_NAME=$(basename "${{ matrix.project }}" .csproj)
257-
dotnet test "${{ matrix.project }}" \
258-
-c Release \
259-
--framework net8.0 \
260-
--no-build \
261-
-v detailed \
262-
--filter "Category!=GPU&Category!=Integration" \
263-
--logger "trx;LogFileName=${PROJECT_NAME}.trx" \
264-
--results-directory ./TestResults
265-
266-
- name: Upload test results
267-
uses: actions/upload-artifact@v4
268-
if: always()
269-
with:
270-
name: test-results-${{ strategy.job-index }}
271-
path: ./TestResults/*.trx
272-
retention-days: 7
273-
274-
# Pack NuGet after all tests pass
216+
# Pack NuGet after version-and-build completes
275217
pack:
276218
name: Pack NuGet
277219
runs-on: ubuntu-latest
278-
needs: [version-and-build, test]
220+
needs: version-and-build
279221
timeout-minutes: 20
280222
if: needs.version-and-build.outputs.should_release == 'true'
281223
steps:

‎.github/workflows/commitlint-autofix.yml‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
name: Auto-Fix Commit Messages
2+
3+
on:
4+
workflow_run:
5+
workflows: ["Commit Message Lint"]
6+
types: [completed]
7+
8+
concurrency:
9+
group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch }}
10+
cancel-in-progress: true
11+
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
16+
jobs:
17+
auto-fix-commits:
18+
name: Squash and Fix Commit Messages
19+
if: |
20+
github.event.workflow_run.conclusion == 'failure' &&
21+
github.event.workflow_run.event == 'pull_request'
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Get PR information
25+
id: get-pr
26+
uses: actions/github-script@v7
27+
with:
28+
script: |
29+
// Get PR associated with the head branch
30+
const headBranch = '${{ github.event.workflow_run.head_branch }}';
31+
const headSha = '${{ github.event.workflow_run.head_sha }}';
32+
33+
core.info(`Looking for PR with head branch: ${headBranch}, sha: ${headSha}`);
34+
35+
const prs = await github.rest.pulls.list({
36+
owner: context.repo.owner,
37+
repo: context.repo.repo,
38+
head: `${context.repo.owner}:${headBranch}`,
39+
state: 'open'
40+
});
41+
42+
if (prs.data.length === 0) {
43+
core.setFailed('No open PR found for this branch. This may occur if the workflow triggered before the PR was opened, or if the branch name does not match any open PR. Please verify that the PR exists and the branch name is correct.');
44+
return;
45+
}
46+
47+
const pr = prs.data[0];
48+
core.info(`Found PR #${pr.number}: ${pr.title}`);
49+
50+
// Verify PR title follows conventional commits (should be auto-fixed already)
51+
const pattern = /^(feat|fix|docs|refactor|perf|test|chore|ci|style)(\(.+\))?!?: .+/;
52+
if (!pattern.test(pr.title)) {
53+
core.setFailed(`PR title does not follow conventional commits: ${pr.title}`);
54+
return;
55+
}
56+
57+
// Don't modify PRs from forks (security)
58+
if (pr.head.repo.full_name !== pr.base.repo.full_name) {
59+
core.setFailed('Cannot auto-fix commits from forked repositories');
60+
return;
61+
}
62+
63+
core.setOutput('pr_number', pr.number);
64+
core.setOutput('pr_title', pr.title);
65+
core.setOutput('head_branch', pr.head.ref);
66+
core.setOutput('base_branch', pr.base.ref);
67+
core.setOutput('head_sha', pr.head.sha);
68+
69+
- name: Checkout PR branch
70+
uses: actions/checkout@v6
71+
with:
72+
ref: ${{ steps.get-pr.outputs.head_branch }}
73+
fetch-depth: 0
74+
token: ${{ secrets.GITHUB_TOKEN }}
75+
76+
- name: Configure Git
77+
run: |
78+
git config user.name "github-actions[bot]"
79+
git config user.email "github-actions[bot]@users.noreply.github.com"
80+
81+
- name: Count commits ahead of base
82+
id: count-commits
83+
run: |
84+
BASE_BRANCH="${{ steps.get-pr.outputs.base_branch }}"
85+
git fetch origin "$BASE_BRANCH"
86+
COMMIT_COUNT=$(git rev-list --count "origin/$BASE_BRANCH..HEAD")
87+
echo "commit_count=$COMMIT_COUNT" >> $GITHUB_OUTPUT
88+
echo "Found $COMMIT_COUNT commits ahead of $BASE_BRANCH"
89+
90+
- name: Squash commits
91+
id: squash-commits
92+
if: steps.count-commits.outputs.commit_count > 1
93+
run: |
94+
BASE_BRANCH="${{ steps.get-pr.outputs.base_branch }}"
95+
PR_TITLE="${{ steps.get-pr.outputs.pr_title }}"
96+
COMMIT_COUNT="${{ steps.count-commits.outputs.commit_count }}"
97+
98+
echo "Squashing $COMMIT_COUNT commits into one..."
99+
100+
# Reset to base branch keeping all changes staged
101+
git reset --soft "origin/$BASE_BRANCH"
102+
103+
# Create the squashed commit with the PR title
104+
git commit -m "$PR_TITLE
105+
106+
Squashed $COMMIT_COUNT commits automatically by GitHub Actions.
107+
This ensures the commit message follows conventional commits format.
108+
109+
Co-Authored-By: github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
110+
111+
echo "Squash complete!"
112+
echo "changes_made=true" >> $GITHUB_OUTPUT
113+
114+
- name: Fix single commit message
115+
id: fix-single-commit
116+
if: steps.count-commits.outputs.commit_count == 1
117+
run: |
118+
PR_TITLE="${{ steps.get-pr.outputs.pr_title }}"
119+
CURRENT_MSG=$(git log -1 --format=%B)
120+
121+
# Check if commit message already matches PR title
122+
FIRST_LINE=$(echo "$CURRENT_MSG" | head -1)
123+
if [ "$FIRST_LINE" = "$PR_TITLE" ]; then
124+
echo "Commit message already matches PR title, no fix needed"
125+
echo "changes_made=false" >> $GITHUB_OUTPUT
126+
exit 0
127+
fi
128+
129+
echo "Amending commit message to match PR title..."
130+
131+
# Preserve the body if it exists (skip subject and blank line, then trim whitespace)
132+
BODY=$(echo "$CURRENT_MSG" | tail -n +3 | awk '{$1=$1};1')
133+
134+
if [ -n "$BODY" ]; then
135+
git commit --amend -m "$PR_TITLE
136+
137+
$BODY"
138+
else
139+
git commit --amend -m "$PR_TITLE
140+
141+
Commit message auto-fixed by GitHub Actions.
142+
143+
Co-Authored-By: github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
144+
fi
145+
echo "changes_made=true" >> $GITHUB_OUTPUT
146+
147+
- name: Force push fixed commits
148+
if: steps.squash-commits.outputs.changes_made == 'true' || steps.fix-single-commit.outputs.changes_made == 'true'
149+
run: |
150+
HEAD_BRANCH="${{ steps.get-pr.outputs.head_branch }}"
151+
HEAD_SHA="${{ steps.get-pr.outputs.head_sha }}"
152+
echo "Force pushing to $HEAD_BRANCH..."
153+
git push origin "$HEAD_BRANCH" --force-with-lease="$HEAD_BRANCH:$HEAD_SHA"
154+
155+
- name: Comment on PR
156+
if: steps.squash-commits.outputs.changes_made == 'true' || steps.fix-single-commit.outputs.changes_made == 'true'
157+
uses: actions/github-script@v7
158+
with:
159+
script: |
160+
const prNumber = ${{ steps.get-pr.outputs.pr_number }};
161+
const commitCount = ${{ steps.count-commits.outputs.commit_count }};
162+
const prTitle = `${{ steps.get-pr.outputs.pr_title }}`;
163+
164+
let message;
165+
if (commitCount > 1) {
166+
message = `### Commit Messages Auto-Fixed
167+
168+
The commitlint check failed because one or more commit messages didn't follow [Conventional Commits](https://www.conventionalcommits.org/) format.
169+
170+
**Action taken** — Squashed ${commitCount} commits into a single commit using the PR title as the commit message.
171+
172+
**New commit message**
173+
\`\`\`
174+
${prTitle}
175+
\`\`\`
176+
177+
The PR branch has been force-pushed with the fixed commit. If you had local changes, you may need to \`git pull --rebase\`.`;
178+
} else {
179+
message = `### Commit Message Auto-Fixed
180+
181+
The commitlint check failed because the commit message didn't follow [Conventional Commits](https://www.conventionalcommits.org/) format.
182+
183+
**Action taken** — Amended the commit message to use the PR title.
184+
185+
**New commit message**
186+
\`\`\`
187+
${prTitle}
188+
\`\`\`
189+
190+
The PR branch has been force-pushed with the fixed commit. If you had local changes, you may need to \`git pull --rebase\`.`;
191+
}
192+
193+
await github.rest.issues.createComment({
194+
owner: context.repo.owner,
195+
repo: context.repo.repo,
196+
issue_number: prNumber,
197+
body: message
198+
});

0 commit comments

Comments
 (0)