Skip to content

feat(release): celebrate community issue authors in release highlights #17842

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
Feb 23, 2026
Merged

feat(release): celebrate community issue authors in release highlights #17842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aed42d6
Initial plan
Copilot Feb 23, 2026
4e388b0
feat: highlight community issues in release notes
Copilot Feb 23, 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
4 changes: 2 additions & 2 deletions .github/workflows/release.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 42 additions & 4 deletions .github/workflows/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,20 @@ steps:
echo "✓ Fetched $PR_COUNT pull requests"
fi

# Fetch community-labeled issues
echo "Fetching issues with 'community' label..."
if ! gh issue list \
--label "community" \
--state all \
--limit 500 \
--json number,title,author,labels,closedAt,url \
> /tmp/gh-aw/release-data/community_issues.json; then
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

The fallback when gh issue list fails writes an empty JSON array but doesn't emit any warning/error, so a transient auth/API failure is indistinguishable from “0 community issues” and will silently suppress community recognition. Consider logging a warning (ideally to stderr) and/or capturing the failure reason before continuing.

Suggested change
> /tmp/gh-aw/release-data/community_issues.json; then
> /tmp/gh-aw/release-data/community_issues.json; then
echo "Warning: Failed to fetch community-labeled issues via 'gh issue list'; treating as zero issues. Check gh authentication and API status." >&2

Copilot uses AI. Check for mistakes.
echo "[]" > /tmp/gh-aw/release-data/community_issues.json
fi

COMMUNITY_COUNT=$(jq length "/tmp/gh-aw/release-data/community_issues.json")
echo "✓ Fetched $COMMUNITY_COUNT community-labeled issues"

# Get the CHANGELOG.md content around this version
if [ -f "CHANGELOG.md" ]; then
cp CHANGELOG.md /tmp/gh-aw/release-data/CHANGELOG.md
Expand All @@ -379,6 +393,7 @@ Generate an engaging release highlights summary for **${{ github.repository }}**
All data is pre-fetched in `/tmp/gh-aw/release-data/`:
- `current_release.json` - Release metadata (tag, name, dates, existing body)
- `pull_requests.json` - PRs merged between `${PREV_RELEASE_TAG}` and `${RELEASE_TAG}` (empty array if first release)
- `community_issues.json` - All issues labeled `community` (issue number, title, author, closedAt, url)
- `CHANGELOG.md` - Full changelog for context (if exists)
- `docs_files.txt` - Available documentation files for linking

Expand All @@ -402,14 +417,31 @@ cat /tmp/gh-aw/release-data/current_release.json | jq
# List PRs (empty if first release)
cat /tmp/gh-aw/release-data/pull_requests.json | jq -r '.[] | "- #\(.number): \(.title) by @\(.author.login)"'

# List community issues
cat /tmp/gh-aw/release-data/community_issues.json | jq -r '.[] | "- #\(.number): \(.title) by @\(.author.login)"'

# Check CHANGELOG context
head -100 /tmp/gh-aw/release-data/CHANGELOG.md 2>/dev/null || echo "No CHANGELOG"

# View available docs
cat /tmp/gh-aw/release-data/docs_files.txt
```

### 2. Categorize & Prioritize
### 2. Identify Community Contributions

Cross-reference `community_issues.json` with `pull_requests.json` to find which community issues are resolved in this release.

A community issue is considered resolved in this release if any PR in `pull_requests.json` references its number in the PR body (e.g., `Fixes #123`, `Closes #123`, `Resolves #123`).

```bash
# Extract PR bodies and cross-reference with community issue numbers
cat /tmp/gh-aw/release-data/pull_requests.json | jq -r '.[].body // ""' | \
grep -oP '(?i)(close[sd]?|fix(e[sd])?|resolve[sd]?)\s*#\K[0-9]+' | sort -u
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

The regex used to extract closing issue numbers won’t match common closing-keyword forms like Fixes: #123 or Fixes (#123) because it only allows whitespace between the keyword and #. If this step is meant to cover standard GitHub closing keyword variants, update the pattern to allow punctuation (e.g., : or () between the keyword and issue reference.

Suggested change
grep -oP '(?i)(close[sd]?|fix(e[sd])?|resolve[sd]?)\s*#\K[0-9]+' | sort -u
grep -oP '(?i)(close[sd]?|fix(e[sd])?|resolve[sd]?)\s*[:()\[\]-]*\s*#\K[0-9]+' | sort -u

Copilot uses AI. Check for mistakes.
```

For each community issue resolved in this release, note the **issue author** from `community_issues.json`. These are the community contributors to celebrate.

### 3. Categorize & Prioritize

Group PRs by category (omit categories with no items):
- **✨ New Features** - User-facing capabilities
Expand All @@ -419,7 +451,7 @@ Group PRs by category (omit categories with no items):
- **⚠️ Breaking Changes** - Requires user action (ALWAYS list first if present)
- **🔧 Internal** - Refactoring, dependencies (usually omit from highlights)

### 3. Write Highlights
### 4. Write Highlights

Structure:
```markdown
Expand All @@ -439,6 +471,12 @@ Structure:
### 📚 Documentation
[Only if significant doc additions/improvements]

### 🌍 Community Contributions
[Only if any community-labeled issues are resolved in this release]
A huge thank you to the community members who reported issues that were resolved in this release:
- **@[author]** for [issue title] ([#number](url))
[One entry per community issue author. Omit this section entirely if no community issues are resolved.]
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

This section’s guidance is internally inconsistent: the template line suggests listing an issue title/number (implying one entry per issue), but the bracketed instruction says “One entry per community issue author” (implying deduping by author). Please clarify whether the output should be per issue, per author (with multiple issues grouped), or something else so the agent can follow it deterministically.

Suggested change
[One entry per community issue author. Omit this section entirely if no community issues are resolved.]
[One entry per resolved community-labeled issue. Omit this section entirely if no community issues are resolved.]

Copilot uses AI. Check for mistakes.

---
For complete details, see [CHANGELOG](https://github.com/github/gh-aw/blob/main/CHANGELOG.md).
```
Expand All @@ -448,9 +486,9 @@ For complete details, see [CHANGELOG](https://github.com/github/gh-aw/blob/main/
- Be specific: "Reduced compilation time by 40%" not "Faster compilation"
- Skip internal changes unless they have user impact
- Use docs links: `[Learn more](https://github.github.com/gh-aw/path/)`
- Keep breaking changes prominent with action items
- Celebrate community contributors: thank each issue author by name with a link to their issue

### 4. Handle Special Cases
### 5. Handle Special Cases

**First Release** (no `${PREV_RELEASE_TAG}`):
```markdown
Expand Down
Loading