From 55d2c985c1a9ecb160cc438b0ccb6867fa477d6c Mon Sep 17 00:00:00 2001 From: Arthur Tazhitdinov Date: Sun, 1 Feb 2026 21:18:11 +0300 Subject: [PATCH] add pr-writer --- .github/workflows/ci.yml | 96 +++++---------------- .github/workflows/pr-writer.yml | 145 ++++++++++++++++++++++++++++++++ 2 files changed, 167 insertions(+), 74 deletions(-) create mode 100644 .github/workflows/pr-writer.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5aae91ed..5a8cb085 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,32 +1,22 @@ -name: CI -'on': +name: CI (build) + +on: push: branches: [master] pull_request: -# permissions: -# contents: read -# issues: write -# pull-requests: write - -# permissions: -# write-all - +permissions: + contents: read jobs: - label: - runs-on: ubuntu-latest - steps: - - uses: actions/labeler@v5 - clang-format: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@v4 with: submodules: recursive - - uses: actions/setup-python@v6 + - uses: actions/setup-python@v5 with: python-version: '3.14' @@ -39,16 +29,18 @@ jobs: sudo apt-get install -y clang-format-21 - name: Run clang-format - run: PATH="/usr/lib/llvm-21/bin:$PATH" ./bin/clang-format-fix && git diff --exit-code || (echo "Please run 'bin/clang-format-fix' to fix formatting issues" && exit 1) + run: | + PATH="/usr/lib/llvm-21/bin:$PATH" ./bin/clang-format-fix + git diff --exit-code || (echo "Please run 'bin/clang-format-fix' to fix formatting issues" && exit 1) cppcheck: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@v4 with: submodules: recursive - - uses: actions/setup-python@v6 + - uses: actions/setup-python@v5 with: python-version: '3.14' @@ -61,11 +53,11 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@v4 with: submodules: recursive - - uses: actions/setup-python@v6 + - uses: actions/setup-python@v5 with: python-version: '3.14' @@ -95,62 +87,18 @@ jobs: if [ -n "$flash_line" ]; then echo "- ${flash_line}"; else echo "- Flash: not found"; fi } >> "$GITHUB_STEP_SUMMARY" + # Upload both the binary and the stats/log so Stage 2 can read them without checkout. - name: Upload firmware.bin artifact uses: actions/upload-artifact@v4 with: - name: ${{ github.event_name == 'pull_request' && format('firmware-bin-pr-{0}-{1}', github.event.pull_request.number, steps.short_sha.outputs.short) || format('firmware-bin-{0}', steps.short_sha.outputs.short) }} + name: firmware-bin path: .pio/build/default/firmware.bin if-no-files-found: error - - name: Comment PR with firmware stats and firmware.bin - if: github.event_name == 'pull_request' - uses: actions/github-script@v8 + - name: Upload build metadata artifact + uses: actions/upload-artifact@v4 with: - script: | - const marker = ''; - const ram = `${{ steps.fw_stats.outputs.ram_line }}`.trim(); - const flash = `${{ steps.fw_stats.outputs.flash_line }}`.trim(); - const prNumber = context.payload.pull_request?.number; - const shortSha = `${{ steps.short_sha.outputs.short }}`.trim() || context.sha.substring(0, 7); - const artifactName = prNumber - ? `firmware-bin-pr-${prNumber}-${shortSha}` - : `firmware-bin-${shortSha}`; - let firmwareLine = 'Firmware: artifact not found'; - try { - const { data: artifacts } = await github.rest.actions.listWorkflowRunArtifacts({ - owner: context.repo.owner, - repo: context.repo.repo, - run_id: context.runId, - }); - const firmwareArtifact = artifacts.artifacts.find((artifact) => artifact.name === artifactName); - if (firmwareArtifact) { - const artifactUiUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/artifacts/${firmwareArtifact.id}`; - firmwareLine = `Firmware: [${artifactName}](${artifactUiUrl})`; - } else { - firmwareLine = `Firmware: artifact not found (${artifactName})`; - } - } catch (error) { - firmwareLine = `Firmware: artifact lookup failed (${error.message})`; - } - const body = `${marker}\n**Firmware build stats**\n\n\`\`\`\n${ram || 'RAM: not found'}\n${flash || 'Flash: not found'}\n\`\`\`\n\n**Firmware binary**\n${firmwareLine}`; - const { data: comments } = await github.rest.issues.listComments({ - owner: context.repo.owner, - repo: context.repo.repo, - issue_number: context.issue.number, - }); - const existing = comments.find((comment) => comment.body && comment.body.includes(marker)); - if (existing) { - await github.rest.issues.updateComment({ - owner: context.repo.owner, - repo: context.repo.repo, - comment_id: existing.id, - body, - }); - } else { - await github.rest.issues.createComment({ - owner: context.repo.owner, - repo: context.repo.repo, - issue_number: context.issue.number, - body, - }); - } + name: build-meta + path: | + pio.log + if-no-files-found: error \ No newline at end of file diff --git a/.github/workflows/pr-writer.yml b/.github/workflows/pr-writer.yml new file mode 100644 index 00000000..fec4f42b --- /dev/null +++ b/.github/workflows/pr-writer.yml @@ -0,0 +1,145 @@ +comment_firmware: + runs-on: ubuntu-latest + steps: + - name: Find the matching CI run for this PR SHA + id: find_run + uses: actions/github-script@v8 + with: + script: | + const owner = context.repo.owner; + const repo = context.repo.repo; + const pr = context.payload.pull_request; + const headSha = pr.head.sha; + + const { data } = await github.rest.actions.listWorkflowRunsForRepo({ + owner, + repo, + event: "pull_request", + per_page: 50, + }); + + const run = data.workflow_runs.find(r => r.head_sha === headSha && r.name === "CI (build)"); + if (!run) core.setFailed(`No matching CI (build) run found for head_sha=${headSha}.`); + + core.setOutput("run_id", String(run.id)); + core.setOutput("run_html_url", run.html_url); + + - name: Locate artifact IDs in the CI run + id: artifacts + uses: actions/github-script@v8 + with: + script: | + const owner = context.repo.owner; + const repo = context.repo.repo; + const runId = Number("${{ steps.find_run.outputs.run_id }}"); + + const { data } = await github.rest.actions.listWorkflowRunArtifacts({ + owner, + repo, + run_id: runId, + per_page: 100, + }); + + const artifacts = data.artifacts || []; + const fw = artifacts.find(a => a.name === "firmware-bin"); + const meta = artifacts.find(a => a.name === "build-meta"); + + if (!meta) core.setFailed("build-meta artifact not found in CI run artifacts."); + // firmware-bin is nice-to-have for linking; fail if you want. + core.setOutput("fw_id", fw ? String(fw.id) : ""); + core.setOutput("meta_id", String(meta.id)); + + - name: Download build-meta artifact zip and extract pio.log + id: parse_log + shell: bash + env: + OWNER: ${{ github.repository_owner }} + REPO: ${{ github.event.repository.name }} + META_ID: ${{ steps.artifacts.outputs.meta_id }} + GH_TOKEN: ${{ github.token }} + run: | + set -euo pipefail + + # Download artifact zip via GitHub API (will redirect to blob storage; -L follows) + api="https://api.github.com/repos/${OWNER}/${REPO}/actions/artifacts/${META_ID}/zip" + curl -sSL \ + -H "Authorization: Bearer ${GH_TOKEN}" \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + -o build-meta.zip \ + "${api}" + + mkdir -p build-meta + unzip -q build-meta.zip -d build-meta + + if [[ ! -f build-meta/pio.log ]]; then + echo "pio.log not found inside build-meta artifact" + echo "ram_line=" >> "$GITHUB_OUTPUT" + echo "flash_line=" >> "$GITHUB_OUTPUT" + exit 0 + fi + + ram_line="$(grep -E "RAM:\s" -m1 build-meta/pio.log || true)" + flash_line="$(grep -E "Flash:\s" -m1 build-meta/pio.log || true)" + + echo "ram_line=${ram_line}" >> "$GITHUB_OUTPUT" + echo "flash_line=${flash_line}" >> "$GITHUB_OUTPUT" + + - name: Post/update PR comment with RAM/Flash + artifact links + uses: actions/github-script@v8 + with: + script: | + const owner = context.repo.owner; + const repo = context.repo.repo; + const prNumber = context.payload.pull_request.number; + + const runId = Number("${{ steps.find_run.outputs.run_id }}"); + const runUrl = "${{ steps.find_run.outputs.run_html_url }}"; + + const marker = ''; + const ram = `${{ steps.parse_log.outputs.ram_line }}`.trim(); + const flash = `${{ steps.parse_log.outputs.flash_line }}`.trim(); + + const fwId = `${{ steps.artifacts.outputs.fw_id }}`.trim(); + const metaId = `${{ steps.artifacts.outputs.meta_id }}`.trim(); + + const fwUrl = fwId ? `https://github.com/${owner}/${repo}/actions/runs/${runId}/artifacts/${fwId}` : null; + const metaUrl = metaId ? `https://github.com/${owner}/${repo}/actions/runs/${runId}/artifacts/${metaId}` : null; + + const body = +`${marker} +**Firmware build stats** + +\`\`\` +${ram || "RAM: not found"} +${flash || "Flash: not found"} +\`\`\` + +**Artifacts** +- CI run: ${runUrl} +- Firmware binary: ${fwUrl ? `[firmware-bin](${fwUrl})` : "artifact not found"} +- Build logs: ${metaUrl ? `[build-meta](${metaUrl})` : "artifact not found"} +`; + + const { data: comments } = await github.rest.issues.listComments({ + owner, + repo, + issue_number: prNumber, + per_page: 100, + }); + + const existing = comments.find(c => (c.body || "").includes(marker)); + if (existing) { + await github.rest.issues.updateComment({ + owner, + repo, + comment_id: existing.id, + body, + }); + } else { + await github.rest.issues.createComment({ + owner, + repo, + issue_number: prNumber, + body, + }); + } \ No newline at end of file