Skip to content

chore(write-release-notes): add contributor filter and length validation#2610

Merged
tusharmath merged 1 commit intomainfrom
improve-release-notes-skill
Mar 20, 2026
Merged

chore(write-release-notes): add contributor filter and length validation#2610
tusharmath merged 1 commit intomainfrom
improve-release-notes-skill

Conversation

@tusharmath
Copy link
Copy Markdown
Collaborator

No description provided.

@github-actions github-actions bot added the type: chore Routine tasks like conversions, reorganization, and maintenance work. label Mar 20, 2026
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 20, 2026

🤖 Augment PR Summary

Summary: Updates the write-release-notes skill to better control attribution and keep generated release notes within a strict size limit.

Changes:

  • Adds a Contributors filter to include only external contributors and omit the section when there are none
  • Adds a length-validation step to enforce a 2000-character maximum for the final release notes
  • Introduces a bundled validate-release-notes.sh script that checks content from stdin or a file and prints PASS/FAIL

Technical Notes: The validator exits with 0 on PASS and 1 on FAIL for easy use in scripts/automation.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

After writing the release notes, run the bundled validation script to confirm the output is under 2000 characters:

```bash
echo "<release notes>" | bash .forge/skills/write-release-notes/scripts/validate-release-notes.sh
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The echo "<release notes>" | bash ... example may not preserve multi-line release notes verbatim when users copy/paste (and echo can also be shell-dependent), which can make the length validation differ from the actual draft. Consider clarifying an input method that preserves newlines exactly so the validator matches what will be posted.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

MAX_CHARS=2000

if [[ $# -ge 1 ]]; then
content=$(cat "$1")
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

content=$(cat ...) via command substitution strips trailing newline(s), so char_count can be under-reported and potentially PASS output that would be at/over the limit when pasted verbatim. This affects both the file-input and stdin paths.

Severity: medium

Other Locations
  • .forge/skills/write-release-notes/scripts/validate-release-notes.sh:18

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@tusharmath tusharmath merged commit a7316c1 into main Mar 20, 2026
10 checks passed
@tusharmath tusharmath deleted the improve-release-notes-skill branch March 20, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: chore Routine tasks like conversions, reorganization, and maintenance work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant