feat: add comment summary template for activity report highlights by mmcky · Pull Request #2 · QuantEcon/action-weekly-report

mmcky · 2026-02-23T03:15:47Z

Comment Summary Template & Release Tracking

Adds the ability to auto-generate an editable highlights template alongside the activity report, now including release tracking. This addresses the workflow gap identified in QuantEcon/meta#280 — where maintainers write a hand-curated comment summarizing key work, but currently have to manually find and list all the merged PRs and releases.

What it does

When --summary-template is enabled, the script collects merged PR details (title, URL, author, labels) during the existing processing loop — no additional API calls required — and generates a comment-template.md file with:

Placeholder summary — Editable topic bullets for high-level themes
Releases table — All non-draft releases published in the period, sorted newest-first (omitted if none)
Merged PRs grouped by repository — Every merged PR with title, URL, labels (in brackets), and author
Contributor acknowledgement — Template section for thanks

Release tracking

The PR also adds a Releases column to the main report table and a consolidated releases table in the comment template:

Fetches /repos/{org}/{repo}/releases for each active repo (one API call per repo)
Filters to non-draft releases with published_at within the date range
Main report: New Releases column between Merged PRs and Commits, included in totals row
Comment template: Releases table at the top with Repository, Release (name/tag with link), Date columns
Works for both organization repos and external tracked repos
Cross-platform date formatting (GNU/Linux and BSD/macOS)

Debug output

All debug messages are now gated behind the --debug CLI flag (or debug: 'true' action input). Output is silent by default for a clean user experience.

How labels help

If PRs have labels (e.g., maintenance, infrastructure, priority: high), they appear in brackets:

  - Major refactor for responsiveness https://...pull/335 [infrastructure, priority: high] (@mmcky)

This makes it much easier to reorganize the flat per-repo list into thematic sections. The value of labels here motivates the labels standardization work in QuantEcon/meta#178.

Usage

CLI:

./generate-report.sh --token=ghp_xxxxx --summary-template
./generate-report.sh --token=ghp_xxxxx --summary-template --summary-template-file=highlights.md
./generate-report.sh --token=ghp_xxxxx --summary-template --debug

GitHub Action:

- uses: QuantEcon/action-weekly-report@v2
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    summary-template: 'true'
    debug: 'true'  # optional — enables verbose output

Changes

generate-report.sh — Added --summary-template, --summary-template-file, and --debug flags; collects merged PR details (title, URL, author, labels) during existing PR fetch; generates grouped template file; fetches releases per repo and adds to report table and comment template; all debug output gated behind debug() function
action.yml — New summary-template, summary-template-file, and debug inputs; new comment-template output
README.md — Updated features, CLI examples, options, inputs/outputs tables, example workflow
CHANGELOG.md — Added unreleased entries for comment template, release tracking, releases column, and debug flag
docs/comment-summary-template.md — Full feature documentation with examples, workflow guide, and security note on safe output handling
docs/README.md — Added to documentation index
.gitignore — Added comment-template.md and .tmp/

Includes

PR feat: add release tracking to comment summary template #3 (feat/release-tracking) — merged into this branch

- New --summary-template flag and summary-template action input - Collects merged PR titles, URLs, authors, and labels during processing - Generates comment-template.md with PRs grouped by repository - Includes placeholder sections for human-written thematic summaries - Labels displayed in brackets to aid categorization - New comment-template action output for downstream workflow steps - Works with both org repos and external repositories - Added docs/comment-summary-template.md with usage guide

Update example workflow in README and feature docs to show the full 3-step flow: generate report + template, create issue, then post the template as the first comment using peter-evans/create-or-update-comment.

@user1

- Extract unique non-bot authors from merged PR data - Format as 'thanks @user1, @user2, and @user3...' acknowledgement - Filter out [bot] accounts and Copilot from contributor list - Use markdown link format [PR Title](url) for clean GitHub rendering

Copilot

Pull request overview

This PR adds a comment summary template feature that auto-generates an editable markdown template containing merged PR details from the activity report period. This addresses the workflow gap where maintainers manually write highlights comments but currently have to manually find and list all merged PRs (as described in QuantEcon/meta#280).

Changes:

Adds --summary-template and --summary-template-file CLI flags and corresponding GitHub Action inputs to enable template generation
Collects merged PR metadata (title, URL, author, labels) during existing report processing without additional API calls
Generates comment-template.md with placeholder topic sections, grouped PRs by repository, and contributor acknowledgements
Adds comprehensive documentation in docs/comment-summary-template.md with usage examples and workflow guides

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
generate-report.sh	Adds CLI argument parsing for summary template flags; collects PR details during existing API calls; generates template with grouped PRs and contributors; adds template content to GITHUB_OUTPUT
action.yml	Defines new `summary-template` and `summary-template-file` inputs with defaults; adds `comment-template` output; passes new inputs as environment variables
docs/comment-summary-template.md	New comprehensive documentation covering feature background, usage (CLI and Action), output format, label benefits, workflows (automated and manual), and configuration options
docs/README.md	Adds comment summary template to documentation index with feature highlights
README.md	Updates features list, CLI examples, options table, inputs/outputs tables, and example workflow to include summary template functionality
CHANGELOG.md	Adds unreleased entry documenting the new feature with all inputs, outputs, and documentation reference
.gitignore	Adds `comment-template.md` and `.tmp/` to prevent generated files from being committed

docs/comment-summary-template.md

* feat: add release tracking to comment summary template - Fetch releases published in the report date range via GitHub API - Display releases with 📦 emoji at top of each repo section, before PRs - Include release name, tag, and link to GitHub release page - Works for both organization repos and external tracked repos - Update docs and CHANGELOG with release tracking details - Auto-detect contributors and use markdown links (carried from template branch) * refactor: use single releases table at top of template (Option A) - Replace per-repo inline release bullets with a single consolidated table - Table columns: Repository, Release (name/tag with link), Date - Sorted by publication date (newest first) - Releases section omitted entirely when no releases in the period - PR listings per repo remain unchanged below the table - Update docs example and CHANGELOG * feat: add Releases count column to report table - Fetch releases unconditionally (not just when summary-template enabled) - Add Releases column between Merged PRs and Commits in report table - Release count links to repo's releases page when > 0 - Include in totals row and Details section - Add to external repos table and totals - Include in summary string output * fix: address Copilot review feedback - Add rate_limited_repos/failed_repos error handling for releases API call - Use cross-platform date formatting (GNU first, BSD fallback) - Remove unused all_template_repos dead code block - Add CHANGELOG entry for Releases column in main report table

Use env: variable and action with: input instead of direct ${{ }} interpolation in run: blocks to prevent shell injection from PR-derived content (titles, labels, author names).

Copilot

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 5 comments.

generate-report.sh

CHANGELOG.md

README.md

docs/comment-summary-template.md

….yml

- Add --debug CLI flag and debug action input (default: false) - Add debug() function that only prints when DEBUG_MODE=true - Replace all 26 'echo DEBUG:' calls with debug() function - Update README, action.yml, and CHANGELOG

Copilot

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 6 comments.

generate-report.sh

docs/comment-summary-template.md

generate-report.sh

- Restructure all api_call assignments to if-guard pattern so set -e doesn't abort the script on API failures (both org and external repos) - Use non-zero-padded day format in releases table (%-d GNU, %e BSD) - Fix comment saying '> 1' to match format_metric() behavior of '> 0' - Soften docs wording from 'all merged PRs' to 'merged PRs' - Document 100-item-per-page API limit in comment template docs

mmcky mentioned this pull request Feb 23, 2026

Standardized Labels for QuantEcon Repositories QuantEcon/meta#290

Open

8 tasks

mmcky added 2 commits February 23, 2026 14:43

docs: add auto-post workflow for comment summary template

bfcaef1

Update example workflow in README and feature docs to show the full 3-step flow: generate report + template, create issue, then post the template as the first comment using peter-evans/create-or-update-comment.

mmcky mentioned this pull request Feb 23, 2026

feat: add release tracking to comment summary template #3

Merged

mmcky requested a review from Copilot February 23, 2026 05:33

Copilot started reviewing on behalf of mmcky February 23, 2026 05:34 View session

Copilot AI reviewed Feb 23, 2026

View reviewed changes

docs/comment-summary-template.md Outdated Show resolved Hide resolved

mmcky added 3 commits February 23, 2026 16:50

fix: resolve merge conflicts with main

ba99e2a

fix: replace unsafe shell interpolation example with safe patterns

326be54

Use env: variable and action with: input instead of direct ${{ }} interpolation in run: blocks to prevent shell injection from PR-derived content (titles, labels, author names).

mmcky requested a review from Copilot February 23, 2026 05:55

Copilot started reviewing on behalf of mmcky February 23, 2026 05:55 View session

Copilot AI reviewed Feb 23, 2026

View reviewed changes

generate-report.sh Outdated Show resolved Hide resolved

CHANGELOG.md Show resolved Hide resolved

README.md Show resolved Hide resolved

docs/comment-summary-template.md Show resolved Hide resolved

docs/comment-summary-template.md Show resolved Hide resolved

mmcky added 2 commits February 23, 2026 17:02

fix: remove no-op shift statements and add trailing newline to action…

a9a8c09

….yml

feat: gate debug output behind --debug flag

a15bffd

- Add --debug CLI flag and debug action input (default: false) - Add debug() function that only prints when DEBUG_MODE=true - Replace all 26 'echo DEBUG:' calls with debug() function - Update README, action.yml, and CHANGELOG

mmcky requested a review from Copilot February 23, 2026 06:08

Copilot started reviewing on behalf of mmcky February 23, 2026 06:09 View session

Copilot AI reviewed Feb 23, 2026

View reviewed changes

mmcky merged commit 25bd331 into main Feb 23, 2026
3 checks passed

mmcky deleted the feat/comment-summary-template branch February 23, 2026 08:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add comment summary template for activity report highlights#2

feat: add comment summary template for activity report highlights#2
mmcky merged 9 commits intomainfrom
feat/comment-summary-template

mmcky commented Feb 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mmcky commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment Summary Template & Release Tracking

What it does

Release tracking

Debug output

How labels help

Usage

Changes

Includes

Related

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mmcky commented Feb 23, 2026 •

edited

Loading