feat(go-pr): add runner input and a single PR checks report

The workflow takes the same runner input as the release workflows.

Findings from go vet and staticcheck now appear as inline annotations
on the pull request diff. A new report job posts one comment with the
result of every check and the coverage. It fails when a check fails or
coverage is below the threshold. It no longer needs the bc command.

A push to a branch with an open pull request now skips its run, because
the pull_request event already runs the checks. Stale runs on the same
branch are cancelled. Every job has a timeout.
This commit is contained in:
2026-10-02 01:20:26 +01:00
parent cce6b9d88c
commit 6b47cbd317
2 changed files with 153 additions and 59 deletions
+133 -59
View File
@@ -24,16 +24,58 @@ on:
type: string type: string
default: "" default: ""
runner:
description: "Runner label, or JSON object such as {\"group\":\"ci\",\"labels\":[\"linux\"]} to select a runner group. Falls back to vars.SHARED_ACTIONS_RUNNER, then ubuntu-latest."
required: false
type: string
default: ""
# Caller must declare these permissions: # Caller must declare these permissions:
# permissions: # permissions:
# contents: read # contents: read
# pull-requests: write # pull-requests: write
# security-events: write # security-events: write
concurrency:
group: go-pr-${{ github.repository }}-${{ github.event_name }}-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true
jobs: jobs:
pre:
name: Detect duplicate run
runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
timeout-minutes: 5
outputs:
skip: ${{ steps.dup.outputs.skip }}
steps:
# A push to a branch with an open PR also fires pull_request; run only the PR one.
- name: Skip push run when a PR is open
id: dup
uses: actions/github-script@v9
with:
script: |
let skip = false;
if (context.eventName === 'push') {
try {
const { data } = await github.rest.pulls.list({
owner: context.repo.owner,
repo: context.repo.repo,
head: `${context.repo.owner}:${context.ref.replace('refs/heads/', '')}`,
state: 'open',
});
skip = data.length > 0;
} catch (e) {
core.warning(`PR lookup failed, running checks: ${e.message}`);
}
}
core.setOutput('skip', String(skip));
if (skip) core.notice('Open PR found for this branch; checks run on the pull_request event.');
static-analysis: static-analysis:
name: Static Analysis name: Static Analysis
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 15
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v6 uses: actions/checkout@v6
@@ -58,6 +100,14 @@ jobs:
- name: Install staticcheck - name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@latest run: go install honnef.co/go/tools/cmd/staticcheck@latest
- name: Register problem matcher
shell: bash
run: |
cat > "$RUNNER_TEMP/go-problem-matcher.json" <<'JSON'
{"problemMatcher":[{"owner":"go-lint","severity":"error","pattern":[{"regexp":"^(?:vet: )?([^\\s:]+\\.go):(\\d+):(\\d+): (.+)$","file":1,"line":2,"column":3,"message":4}]}]}
JSON
echo "::add-matcher::$RUNNER_TEMP/go-problem-matcher.json"
- name: Run go vet - name: Run go vet
run: go vet ./... run: go vet ./...
@@ -66,7 +116,10 @@ jobs:
security-scan: security-scan:
name: Security Scan name: Security Scan
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 20
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v6 uses: actions/checkout@v6
@@ -123,7 +176,10 @@ jobs:
gosec: gosec:
name: Gosec SARIF name: Gosec SARIF
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 15
permissions: permissions:
contents: read contents: read
security-events: write security-events: write
@@ -164,7 +220,10 @@ jobs:
goreleaser-check: goreleaser-check:
name: GoReleaser Config Validation name: GoReleaser Config Validation
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 10
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v6 uses: actions/checkout@v6
@@ -196,7 +255,10 @@ jobs:
codeql: codeql:
name: CodeQL Analysis name: CodeQL Analysis
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 45
permissions: permissions:
contents: read contents: read
security-events: write security-events: write
@@ -233,7 +295,10 @@ jobs:
test: test:
name: Tests & Coverage name: Tests & Coverage
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: pre
if: needs.pre.outputs.skip != 'true'
timeout-minutes: 30
outputs: outputs:
coverage: ${{ steps.coverage.outputs.coverage }} coverage: ${{ steps.coverage.outputs.coverage }}
steps: steps:
@@ -276,66 +341,75 @@ jobs:
echo "coverage=$COVERAGE" >> $GITHUB_OUTPUT echo "coverage=$COVERAGE" >> $GITHUB_OUTPUT
echo "Total Coverage: $COVERAGE%" echo "Total Coverage: $COVERAGE%"
coverage-report: report:
name: Coverage Report name: PR Checks Report
runs-on: ubuntu-latest runs-on: ${{ fromJSON(startsWith(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest', '{') && inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest' || toJSON(inputs.runner || vars.SHARED_ACTIONS_RUNNER || 'ubuntu-latest')) }}
needs: test needs: [pre, static-analysis, security-scan, gosec, goreleaser-check, codeql, test]
if: always() && needs.test.result == 'success' if: always() && needs.pre.outputs.skip != 'true'
timeout-minutes: 10
permissions:
contents: read
pull-requests: write
steps: steps:
- name: Comment coverage on PR - name: Summarise, comment and gate
if: github.event_name == 'pull_request'
uses: actions/github-script@v9 uses: actions/github-script@v9
env:
NEEDS: ${{ toJSON(needs) }}
THRESHOLD: ${{ inputs.coverage-threshold }}
with: with:
script: | script: |
const coverage = '${{ needs.test.outputs.coverage }}'; const needs = JSON.parse(process.env.NEEDS);
const threshold = ${{ inputs.coverage-threshold }}; const threshold = Number(process.env.THRESHOLD);
const coverageNum = parseFloat(coverage); const labels = {
const hasThreshold = threshold > 0; 'static-analysis': 'Static analysis (vet, staticcheck)',
const meetsThreshold = !hasThreshold || coverageNum >= threshold; 'security-scan': 'Security scan (TruffleHog, govulncheck)',
const emoji = meetsThreshold ? '✅' : '⚠️'; 'gosec': 'Gosec',
const status = hasThreshold ? (meetsThreshold ? 'meets' : 'below') + ' threshold' : 'reported'; 'goreleaser-check': 'GoReleaser config',
'codeql': 'CodeQL',
let body = `## ${emoji} Test Coverage Report\n\n| Metric | Value |\n|--------|-------|\n| **Total Coverage** | ${coverage}% |`; 'test': 'Tests (race) & coverage',
if (hasThreshold) { };
body += `\n| **Threshold** | ${threshold}% |\n| **Status** | ${emoji} Coverage ${status} |`; const icon = { success: '✅', failure: '❌', cancelled: '🚫', skipped: '⏭️' };
const failed = [];
let body = '<!-- go-pr-report -->\n## PR checks\n\n| Check | Result |\n|---|---|\n';
for (const [key, label] of Object.entries(labels)) {
const result = needs[key]?.result ?? 'skipped';
if (result === 'failure' || result === 'cancelled') failed.push(label);
body += `| ${label} | ${icon[result] ?? result} ${result} |\n`;
} }
const { data: comments } = await github.rest.issues.listComments({ const coverage = parseFloat(needs.test?.outputs?.coverage);
issue_number: context.issue.number, const hasCoverage = !Number.isNaN(coverage);
owner: context.repo.owner, if (hasCoverage) {
repo: context.repo.repo, body += `\n**Total coverage:** ${coverage}%`;
}); if (threshold > 0) {
const ok = coverage >= threshold;
body += ` (threshold ${threshold}%: ${ok ? '✅ met' : '❌ below'})`;
if (!ok) failed.push(`Coverage ${coverage}% below ${threshold}%`);
}
body += '\n';
}
body += `\n[Workflow run](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})`;
const botComment = comments.find(comment => await core.summary.addRaw(body, true).write();
comment.user.type === 'Bot' &&
comment.body.includes('Test Coverage Report')
);
if (botComment) { if (context.eventName === 'pull_request') {
await github.rest.issues.updateComment({ try {
comment_id: botComment.id, const comments = await github.paginate(github.rest.issues.listComments, {
owner: context.repo.owner, owner: context.repo.owner,
repo: context.repo.repo, repo: context.repo.repo,
body: body issue_number: context.issue.number,
}); });
} else { const existing = comments.find(c => c.user.type === 'Bot' &&
await github.rest.issues.createComment({ (c.body.includes('<!-- go-pr-report -->') || c.body.includes('Test Coverage Report')));
issue_number: context.issue.number, const args = { owner: context.repo.owner, repo: context.repo.repo, body };
owner: context.repo.owner, if (existing) {
repo: context.repo.repo, await github.rest.issues.updateComment({ ...args, comment_id: existing.id });
body: body } else {
}); await github.rest.issues.createComment({ ...args, issue_number: context.issue.number });
}
} catch (e) {
core.warning(`Could not post PR comment (fork PR or missing pull-requests: write): ${e.message}`);
}
} }
- name: Check coverage threshold if (failed.length) core.setFailed(`Failed: ${failed.join('; ')}`);
if: inputs.coverage-threshold > 0
run: |
COVERAGE=${{ needs.test.outputs.coverage }}
THRESHOLD=${{ inputs.coverage-threshold }}
echo "Coverage: $COVERAGE%"
echo "Threshold: $THRESHOLD%"
if (( $(echo "$COVERAGE < $THRESHOLD" | bc -l) )); then
echo "❌ Coverage $COVERAGE% is below threshold $THRESHOLD%"
exit 1
fi
echo "✅ Coverage $COVERAGE% meets threshold $THRESHOLD%"
+20
View File
@@ -4,6 +4,21 @@ Reusable workflows and composite actions for Go projects.
## Reusable Workflows ## Reusable Workflows
### Runner selection
Every reusable workflow accepts `runner` (label, or a JSON object to pick a runner group):
```yaml
with:
runner: self-hosted
# or
runner: '{"group":"ci-linux","labels":["x64"]}'
```
Resolution order: `inputs.runner`, repository/org variable `SHARED_ACTIONS_RUNNER`, `ubuntu-latest`.
Set the variable once to move every consumer. In `go-release-cgo.yaml` the build matrix keeps its
per-platform `os`; `runner` covers the other jobs. Runner groups exist only for organisations and enterprises.
### `go-release.yaml` ### `go-release.yaml`
Standard Go release workflow using GoReleaser. Standard Go release workflow using GoReleaser.
@@ -57,6 +72,11 @@ jobs:
Pull request checks: tests, linting, security scans. Pull request checks: tests, linting, security scans.
- `go vet` / `staticcheck` findings show as inline annotations on the PR diff; gosec and CodeQL post to code scanning.
- The `report` job posts one sticky comment with every check's result and coverage, and fails if any check fails or coverage is below `coverage-threshold`. Require `PR Checks Report` in branch protection.
- A push to a branch with an open PR skips the duplicate run; stale runs on the same branch are cancelled.
- Fork PRs cannot receive the comment; the report still lands in the job summary.
```yaml ```yaml
jobs: jobs:
pr-checks: pr-checks: