|
| 1 | +name: Post Coverage Comment |
| 2 | + |
| 3 | +on: |
| 4 | + workflow_run: |
| 5 | + workflows: ["Run Unit Tests"] |
| 6 | + types: |
| 7 | + - completed |
| 8 | + |
| 9 | +permissions: |
| 10 | + pull-requests: write |
| 11 | + actions: read |
| 12 | + |
| 13 | +jobs: |
| 14 | + comment: |
| 15 | + runs-on: ubuntu-latest |
| 16 | + if: > |
| 17 | + github.event.workflow_run.event == 'pull_request' && |
| 18 | + github.event.workflow_run.conclusion == 'success' |
| 19 | + steps: |
| 20 | + - name: Download Coverage Artifacts |
| 21 | + uses: actions/download-artifact@v4 |
| 22 | + with: |
| 23 | + run-id: ${{ github.event.workflow_run.id }} |
| 24 | + github-token: ${{ secrets.A2A_BOT_PAT }} |
| 25 | + name: coverage-data |
| 26 | + |
| 27 | + - name: Upload Coverage Report |
| 28 | + id: upload-report |
| 29 | + uses: actions/upload-artifact@v4 |
| 30 | + with: |
| 31 | + name: coverage-report |
| 32 | + path: coverage/ |
| 33 | + retention-days: 14 |
| 34 | + |
| 35 | + - name: Post Comment |
| 36 | + uses: actions/github-script@v6 |
| 37 | + env: |
| 38 | + ARTIFACT_URL: ${{ steps.upload-report.outputs.artifact-url }} |
| 39 | + with: |
| 40 | + script: | |
| 41 | + const fs = require('fs'); |
| 42 | +
|
| 43 | + const { owner, repo } = context.repo; |
| 44 | + const headSha = context.payload.workflow_run.head_commit.id; |
| 45 | +
|
| 46 | + const loadSummary = (path) => { |
| 47 | + try { |
| 48 | + const data = JSON.parse(fs.readFileSync(path, 'utf8')); |
| 49 | + // Map Python coverage.json format to expected internal summary format |
| 50 | + if (data.totals && data.files) { |
| 51 | + const summary = { |
| 52 | + total: { |
| 53 | + statements: { pct: data.totals.percent_covered } |
| 54 | + } |
| 55 | + }; |
| 56 | + for (const [file, fileData] of Object.entries(data.files)) { |
| 57 | + // Python coverage uses absolute paths or relative to project root |
| 58 | + // We keep it as is for comparison |
| 59 | + summary[file] = { |
| 60 | + statements: { pct: fileData.summary.percent_covered } |
| 61 | + }; |
| 62 | + } |
| 63 | + return summary; |
| 64 | + } |
| 65 | + return data; |
| 66 | + } catch (e) { |
| 67 | + console.log(`Could not read ${path}: ${e}`); |
| 68 | + return null; |
| 69 | + } |
| 70 | + }; |
| 71 | +
|
| 72 | + const baseSummary = loadSummary('./coverage-base.json'); |
| 73 | + const prSummary = loadSummary('./coverage-pr.json'); |
| 74 | +
|
| 75 | + if (!baseSummary || !prSummary) { |
| 76 | + console.log("Missing coverage data, skipping comment."); |
| 77 | + return; |
| 78 | + } |
| 79 | +
|
| 80 | + let baseBranch = 'main'; |
| 81 | + try { |
| 82 | + baseBranch = fs.readFileSync('./BASE_BRANCH', 'utf8').trim(); |
| 83 | + } catch (e) { |
| 84 | + console.log("Could not read BASE_BRANCH, defaulting to main."); |
| 85 | + } |
| 86 | +
|
| 87 | + let markdown = `### 🧪 Code Coverage (vs \`${baseBranch}\`)\n\n`; |
| 88 | + |
| 89 | + markdown += `[⬇️ **Download Full Report**](${process.env.ARTIFACT_URL})\n\n`; |
| 90 | +
|
| 91 | + const metric = 'statements'; |
| 92 | + const getPct = (summaryItem, m) => summaryItem && summaryItem[m] ? Number(summaryItem[m].pct) : 0; |
| 93 | + |
| 94 | + const formatDiff = (oldPct, newPct) => { |
| 95 | + const diff = (newPct - oldPct).toFixed(2); |
| 96 | + |
| 97 | + let icon = ''; |
| 98 | + if (diff > 0) icon = '🟢'; |
| 99 | + else if (diff < 0) icon = '🔴'; |
| 100 | + else icon = '⚪️'; |
| 101 | +
|
| 102 | + const diffStr = diff > 0 ? `+${diff}%` : `${diff}%`; |
| 103 | + return `${icon} ${diffStr}`; |
| 104 | + }; |
| 105 | +
|
| 106 | + const fileUrl = (path) => `https://github.com/${owner}/${repo}/blob/${headSha}/${path}`; |
| 107 | +
|
| 108 | + const allFiles = new Set([...Object.keys(baseSummary), ...Object.keys(prSummary)]); |
| 109 | + allFiles.delete('total'); |
| 110 | + const workspacePath = process.env.GITHUB_WORKSPACE ? process.env.GITHUB_WORKSPACE + '/' : ''; |
| 111 | +
|
| 112 | + let changedRows = []; |
| 113 | + let newRows = []; |
| 114 | + |
| 115 | + for (const file of allFiles) { |
| 116 | + const baseFile = baseSummary[file]; |
| 117 | + const prFile = prSummary[file]; |
| 118 | +
|
| 119 | + if (!prFile) continue; |
| 120 | +
|
| 121 | + const oldPct = getPct(baseFile, metric); |
| 122 | + const newPct = getPct(prFile, metric); |
| 123 | +
|
| 124 | + const relativeFilePath = file.replace(workspacePath, ''); |
| 125 | + const linkedPath = `[${relativeFilePath}](${fileUrl(relativeFilePath)})`; |
| 126 | +
|
| 127 | + if (!baseFile && prFile) { |
| 128 | + newRows.push(`| ${linkedPath} (**new**) | — | ${newPct.toFixed(2)}% | — |\n`); |
| 129 | + } else if (oldPct !== newPct) { |
| 130 | + changedRows.push(`| ${linkedPath} | ${oldPct.toFixed(2)}% | ${newPct.toFixed(2)}% | ${formatDiff(oldPct, newPct)} |\n`); |
| 131 | + } |
| 132 | + } |
| 133 | +
|
| 134 | + if (changedRows.length === 0 && newRows.length === 0) { |
| 135 | + markdown += `\n_No coverage changes._\n`; |
| 136 | + } else { |
| 137 | + markdown += `| | Base | PR | Delta |\n`; |
| 138 | + markdown += `| :--- | :---: | :---: | :---: |\n`; |
| 139 | + |
| 140 | + if (changedRows.length > 0) { |
| 141 | + markdown += changedRows.sort().join(''); |
| 142 | + } |
| 143 | + if (newRows.length > 0) { |
| 144 | + markdown += newRows.sort().join(''); |
| 145 | + } |
| 146 | +
|
| 147 | + const oldTotalPct = getPct(baseSummary.total, metric); |
| 148 | + const newTotalPct = getPct(prSummary.total, metric); |
| 149 | + if (oldTotalPct !== newTotalPct) { |
| 150 | + markdown += `| **Total** | ${oldTotalPct.toFixed(2)}% | ${newTotalPct.toFixed(2)}% | ${formatDiff(oldTotalPct, newTotalPct)} |\n`; |
| 151 | + } |
| 152 | + } |
| 153 | +
|
| 154 | + markdown += `\n\n_Generated by [coverage-comment.yml](https://github.com/${owner}/${repo}/actions/workflows/coverage-comment.yml)_`; |
| 155 | +
|
| 156 | + const prNumber = fs.readFileSync('./PR_NUMBER', 'utf8').trim(); |
| 157 | +
|
| 158 | + if (!prNumber) { |
| 159 | + console.log("No PR number found."); |
| 160 | + return; |
| 161 | + } |
| 162 | +
|
| 163 | + const comments = await github.rest.issues.listComments({ |
| 164 | + owner, |
| 165 | + repo, |
| 166 | + issue_number: prNumber, |
| 167 | + }); |
| 168 | +
|
| 169 | + const existingComment = comments.data.find(c => |
| 170 | + c.body.includes('Generated by [coverage-comment.yml]') && |
| 171 | + c.user.type === 'Bot' |
| 172 | + ); |
| 173 | +
|
| 174 | + if (existingComment) { |
| 175 | + await github.rest.issues.updateComment({ |
| 176 | + owner, |
| 177 | + repo, |
| 178 | + comment_id: existingComment.id, |
| 179 | + body: markdown |
| 180 | + }); |
| 181 | + } else { |
| 182 | + await github.rest.issues.createComment({ |
| 183 | + owner, |
| 184 | + repo, |
| 185 | + issue_number: prNumber, |
| 186 | + body: markdown |
| 187 | + }); |
| 188 | + } |
0 commit comments