feat(ci): Add code coverage reporting to GitHub Actions (#246)
* bd sync: 2026-01-05 06:22:43 * bd sync: 2026-01-05 07:08:42 * bd sync: 2026-01-05 07:24:58 * feat: Add code coverage PR comment to GitHub Actions Adds a step to the CI workflow that: - Collects code coverage during test runs - Parses per-package coverage percentages - Posts a markdown table comment on PRs with: - Overall coverage percentage - Per-package breakdown table - Updates existing comment on subsequent pushes Closes: ga-tl5 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): handle fork PR permissions for coverage comment Fork PRs cannot write comments via GITHUB_TOKEN due to security restrictions. Add condition to skip comment step for external PRs and upload coverage report as artifact instead. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(ci): separate coverage into dedicated job - Test job now uploads coverage.out and test-output.txt as artifacts - New Coverage Report job runs after tests complete - Downloads coverage data, generates report, uploads as artifact - Always uploads coverage-report artifact (for both fork and internal PRs) - Comments on PR only for internal PRs (fork PRs get notice message) - Cleaner separation of concerns 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): coverage job waits for both test and integration Coverage Report job now depends on [test, integration] to ensure it only runs after all test stages complete successfully. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): restore Coverage Report job after Test and Integration Coverage Report job now properly: - Depends on [test, integration] - waits for both to complete - Downloads coverage data from Test job - Generates and uploads coverage-report artifact - Comments on internal PRs only 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test: add debugging output to TestInstallTownRoleSlots Add logging for gt install output and bd list to help diagnose CI failures where agent beads may not be created. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): update beads to @main and fix lint errors - Change CI to install beads from @main instead of @latest (latest release doesn't support role/agent issue types) - Remove error return from cleanBeadsRuntimeFiles since all errors are intentionally ignored (best-effort cleanup) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): pin beads to v0.44.0 for agent/role types Beads main recently extracted Gas Town-specific types (agent, role, etc.) from core. Pin CI to v0.44.0 which still has these types. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(ci): unpin beads version back to @latest Beads v0.46.0 now supports agent/role types again. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: remove stale gastown/.beads files from PR These beads files are local runtime state that shouldn't be committed. 🤖 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>
This commit is contained in:
+118
-2
@@ -68,6 +68,8 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v5
|
uses: actions/setup-go@v5
|
||||||
@@ -82,8 +84,122 @@ jobs:
|
|||||||
- name: Build
|
- name: Build
|
||||||
run: go build -v ./cmd/gt
|
run: go build -v ./cmd/gt
|
||||||
|
|
||||||
- name: Test
|
- name: Test with Coverage
|
||||||
run: go test -v -race -short ./...
|
run: |
|
||||||
|
go test -race -short -coverprofile=coverage.out ./... 2>&1 | tee test-output.txt
|
||||||
|
|
||||||
|
- name: Upload Coverage Data
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: coverage-data
|
||||||
|
path: |
|
||||||
|
coverage.out
|
||||||
|
test-output.txt
|
||||||
|
|
||||||
|
# Separate job to process coverage after ALL tests complete
|
||||||
|
coverage:
|
||||||
|
name: Coverage Report
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: [test, integration]
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.24'
|
||||||
|
|
||||||
|
- name: Download Coverage Data
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
name: coverage-data
|
||||||
|
|
||||||
|
- name: Generate Coverage Report
|
||||||
|
run: |
|
||||||
|
# Parse per-package coverage from test output
|
||||||
|
echo "## Code Coverage Report" > coverage-report.md
|
||||||
|
echo "" >> coverage-report.md
|
||||||
|
|
||||||
|
# Get overall coverage
|
||||||
|
TOTAL=$(go tool cover -func=coverage.out | grep total | awk '{print $3}')
|
||||||
|
echo "**Overall Coverage: ${TOTAL}**" >> coverage-report.md
|
||||||
|
echo "" >> coverage-report.md
|
||||||
|
|
||||||
|
# Create per-package table
|
||||||
|
echo "| Package | Coverage |" >> coverage-report.md
|
||||||
|
echo "|---------|----------|" >> coverage-report.md
|
||||||
|
|
||||||
|
# Extract package coverage from all test output lines
|
||||||
|
grep -E "github.com/steveyegge/gastown.*coverage:" test-output.txt | \
|
||||||
|
sed 's/.*github.com\/steveyegge\/gastown\///' | \
|
||||||
|
awk '{
|
||||||
|
pkg = $1
|
||||||
|
for (i=2; i<=NF; i++) {
|
||||||
|
if ($i == "coverage:") {
|
||||||
|
cov = $(i+1)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
printf "| %s | %s |\n", pkg, cov
|
||||||
|
}' | sort -u >> coverage-report.md
|
||||||
|
|
||||||
|
echo "" >> coverage-report.md
|
||||||
|
echo "---" >> coverage-report.md
|
||||||
|
echo "_Generated by CI_" >> coverage-report.md
|
||||||
|
|
||||||
|
# Show in logs
|
||||||
|
cat coverage-report.md
|
||||||
|
|
||||||
|
- name: Upload Coverage Report
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: coverage-report
|
||||||
|
path: coverage-report.md
|
||||||
|
retention-days: 30
|
||||||
|
|
||||||
|
- name: Comment Coverage on PR
|
||||||
|
# Only for internal PRs - fork PRs can't write comments
|
||||||
|
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const fs = require('fs');
|
||||||
|
const report = fs.readFileSync('coverage-report.md', 'utf8');
|
||||||
|
|
||||||
|
// Find existing coverage comment
|
||||||
|
const { data: comments } = await github.rest.issues.listComments({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
issue_number: context.issue.number,
|
||||||
|
});
|
||||||
|
|
||||||
|
const botComment = comments.find(comment =>
|
||||||
|
comment.user.type === 'Bot' &&
|
||||||
|
comment.body.includes('## Code Coverage Report')
|
||||||
|
);
|
||||||
|
|
||||||
|
if (botComment) {
|
||||||
|
await github.rest.issues.updateComment({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
comment_id: botComment.id,
|
||||||
|
body: report
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
await github.rest.issues.createComment({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
issue_number: context.issue.number,
|
||||||
|
body: report
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
- name: Coverage Note for Fork PRs
|
||||||
|
if: github.event.pull_request.head.repo.full_name != github.repository
|
||||||
|
run: |
|
||||||
|
echo "::notice::Coverage report uploaded as artifact (fork PRs cannot post comments). Download from Actions tab."
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
name: Lint
|
name: Lint
|
||||||
|
|||||||
@@ -143,6 +143,21 @@ func TestInstallTownRoleSlots(t *testing.T) {
|
|||||||
t.Fatalf("gt install failed: %v\nOutput: %s", err, output)
|
t.Fatalf("gt install failed: %v\nOutput: %s", err, output)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Log install output for CI debugging
|
||||||
|
t.Logf("gt install output:\n%s", output)
|
||||||
|
|
||||||
|
// Verify beads directory was created
|
||||||
|
beadsDir := filepath.Join(hqPath, ".beads")
|
||||||
|
if _, err := os.Stat(beadsDir); os.IsNotExist(err) {
|
||||||
|
t.Fatalf("beads directory not created at %s", beadsDir)
|
||||||
|
}
|
||||||
|
|
||||||
|
// List beads for debugging
|
||||||
|
listCmd := exec.Command("bd", "--no-daemon", "list", "--type=agent")
|
||||||
|
listCmd.Dir = hqPath
|
||||||
|
listOutput, _ := listCmd.CombinedOutput()
|
||||||
|
t.Logf("bd list --type=agent output:\n%s", listOutput)
|
||||||
|
|
||||||
assertSlotValue(t, hqPath, "hq-mayor", "role", "hq-mayor-role")
|
assertSlotValue(t, hqPath, "hq-mayor", "role", "hq-mayor-role")
|
||||||
assertSlotValue(t, hqPath, "hq-deacon", "role", "hq-deacon-role")
|
assertSlotValue(t, hqPath, "hq-deacon", "role", "hq-deacon-role")
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user