Skip to content

feat(api-consumption-report): render charts as inline markdown images #26150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Apr 14, 2026
+14 −6
Merged

feat(api-consumption-report): render charts as inline markdown images #26150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53cee51
Initial plan
Copilot Apr 14, 2026
67b3d4d
feat(api-consumption-report): render charts as inline markdown images
Copilot Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions .github/workflows/api-consumption-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,15 @@ ls -la "$RUNNER_TEMP/gh-aw/safeoutputs/upload-artifacts/"

After confirming the files exist in the staging directory, call `upload_artifact` for each chart using the **filename only** (not a subdirectory path). For example, use `path: "api_calls_trend.png"` — NOT `path: "charts/api_calls_trend.png"`.

Call `upload_artifact` once per chart (5 total). Collect and record the returned `aw_*` ID for each chart.
Call `upload_artifact` once per chart (5 total), specifying the `temporary_id` for each so the chart can be embedded as an inline image in the discussion:

| Chart file | `temporary_id` |
|---|---|
| `api_calls_trend.png` | `aw_api_trend` |
| `workflow_api_trend.png` | `aw_wf_trend` |
| `api_heatmap.png` | `aw_heatmap` |
| `api_burners_donut.png` | `aw_donut` |
| `api_by_workflow.png` | `aw_by_wf` |
Comment on lines +321 to +329
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo runs the generated .github/workflows/api-consumption-report.lock.yml (see its header: “edit the corresponding .md file and run: gh aw compile”). Since this PR updates the .md prompt to use temporary_id / #aw_* image references, the lock file must be regenerated and committed as part of this change; otherwise the workflow will continue using the old prompt and the lock-file freshness check will report a stale lock file.

Copilot uses AI. Check for mistakes.

---

Expand Down Expand Up @@ -353,39 +361,39 @@ Create a discussion with the following structure. Replace placeholders with real

### 🔗 GitHub API Calls Trend (90 days)

📎 **[Chart: GitHub API Calls Trend](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})** — artifact `{api_calls_trend_aw_id}`
![GitHub API Calls Trend](#aw_api_trend)

{2–3 sentences: highlight the trend direction, peak days, and any notable spikes in total REST API consumption}

---

### 🔗 GitHub API Calls by Workflow Trend (30 days)

📎 **[Chart: GitHub API Calls by Workflow Trend](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})** — artifact `{workflow_api_trend_aw_id}`
![GitHub API Calls by Workflow Trend](#aw_wf_trend)

{2–3 sentences: note which workflows consistently consume the most API quota and any emerging patterns over the last 30 days}

---

### 🔗 GitHub REST API Calls Heatmap (90 days)

📎 **[Chart: GitHub REST API Calls Heatmap](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})** — artifact `{api_heatmap_aw_id}`
![GitHub REST API Calls Heatmap](#aw_heatmap)

{2–3 sentences: describe weekly patterns, busiest days, and any anomalies in REST API consumption}

---

### 🍩 Top API Burners (24h)

📎 **[Chart: Top API Burners](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})** — artifact `{api_burners_donut_aw_id}`
![Top API Burners](#aw_donut)

{2–3 sentences: describe which workflows dominate API consumption, their share of the total, and any concentration risk}

---

### 🔗 GitHub REST API Consumption by Workflow (last 24h)

📎 **[Chart: GitHub REST API Consumption by Workflow](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})** — artifact `{api_by_workflow_aw_id}`
![GitHub REST API Consumption by Workflow](#aw_by_wf)

{2–3 sentences: identify the top REST API consumers, note any workflows near the 15k/hr limit, and suggest optimisation opportunities}

Expand Down
Loading