Skip to content

docs(release): require editorial GitHub notes - #946

Merged
benvinegar merged 1 commit into
mainfrom
docs/editorial-release-notes-guidance
Aug 31, 2026
Merged

benvinegar merged 1 commit into
mainfrom
docs/editorial-release-notes-guidance

Conversation

@benvinegar

Copy link
Copy Markdown
Member

Summary

  • replace the flat generated-PR release template with editorial, user-focused guidance
  • require exact-version hunk update and npm installation commands plus compatibility notes
  • explicitly acknowledge all external contributors and preserve the complete PR inventory in a collapsed details block
  • distinguish stable hunk.dev notes from self-contained GitHub prerelease notes

Validation

  • bunx oxfmt --check skills/hunk-release/SKILL.md .changeset/editorial-release-notes.md
  • git diff --check

This PR description was generated by Pi using gpt-5.6-sol

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
hunk-web Ignored Ignored Aug 31, 2026 4:18am

Request Review

@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR replaces generated-style GitHub release notes with editorial, user-focused guidance and records the documentation-only change using an empty Changeset.

  • Requires exact-version upgrade and npm installation commands, compatibility notes, and curated highlights.
  • Adds explicit external-contributor acknowledgments and a collapsed complete PR inventory.
  • Distinguishes hosted stable-release notes from self-contained GitHub prerelease notes.

Confidence Score: 4/5

The release guidance should be corrected before merging because Homebrew users would be instructed to run an unsupported version-pinned update command.

The new template applies hunk update <version> to existing managed installations generally, while the updater explicitly rejects version selection for Homebrew installations.

Files Needing Attention: skills/hunk-release/SKILL.md

Important Files Changed

Filename Overview
skills/hunk-release/SKILL.md Expands the release-note procedure substantially, but its universal version-pinned update command fails for Homebrew-managed installations.
.changeset/editorial-release-notes.md Adds a valid canonical empty Changeset describing the release-documentation update.
Prompt To Fix All With AI
### Issue 1
skills/hunk-release/SKILL.md:196
**Pinned updates break Homebrew**

When a Homebrew user follows the required `hunk update <version>` instruction, the updater rejects explicit versions with “Homebrew installs cannot select a specific Hunk version,” causing the documented upgrade to fail instead of updating Hunk. Provide Homebrew-specific guidance or exclude Homebrew from the pinned command.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs(release): require editorial GitHub ..." | Re-trigger Greptile

## What's Changed
- Open with one short paragraph describing the release's product theme and user impact.
- Group a small number of meaningful changes under descriptive headings. Explain what users can now do; do not restate commit titles or reproduce the changelog.
- Include both upgrade and npm installation instructions using the exact release: `hunk update <version>` for existing managed installs and `npm install -g hunkdiff@<version>` for npm installs or first-time npm users. Add other installation-method-specific guidance only when relevant.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Pinned updates break Homebrew

When a Homebrew user follows the required hunk update <version> instruction, the updater rejects explicit versions with “Homebrew installs cannot select a specific Hunk version,” causing the documented upgrade to fail instead of updating Hunk. Provide Homebrew-specific guidance or exclude Homebrew from the pinned command.

Prompt To Fix With AI
This is a comment left during a code review.
Path: skills/hunk-release/SKILL.md
Line: 196

Comment:
**Pinned updates break Homebrew**

When a Homebrew user follows the required `hunk update <version>` instruction, the updater rejects explicit versions with “Homebrew installs cannot select a specific Hunk version,” causing the documented upgrade to fail instead of updating Hunk. Provide Homebrew-specific guidance or exclude Homebrew from the pinned command.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

@benvinegar
benvinegar merged commit f784022 into main Aug 31, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant