Add public Changelog with API & integrator changes per month#40
Open
ejntaylor wants to merge 2 commits into
Open
Add public Changelog with API & integrator changes per month#40ejntaylor wants to merge 2 commits into
ejntaylor wants to merge 2 commits into
Conversation
Adds src/content/docs/changelog.md covering Nov 2025 → May 2026, generated by reading merged PRs from patchstack/saas and patchstack/hub and curating customer-facing changes into a monthly digest. Each month calls out API/breaking/behaviour changes in a dedicated section before the highlights, so integrators get upfront visibility into changes that affect their integrations. Wires the page into the Starlight sidebar after FAQ and adds a project-scoped Claude skill (.claude/skills/changelog/SKILL.md) that auto-detects initial vs incremental mode and regenerates this page from recent merged PRs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Comprehensive, well-structured changelog generation skill with clear workflows and doc templates. 🎯 Quality: 69% Average · 📦 Size: Extra Large — strongly consider breaking this down 📈 This month: Your 51st PR — above team average · Averaging Good |
✅ Deploy Preview for deluxe-meerkat-8daf24 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
iv1310
approved these changes
May 18, 2026
Addresses review feedback that the page felt too busy and that breaking changes weren't sufficiently separated. Skill changes (.claude/skills/changelog/SKILL.md): - Cap Highlights at 4-6 bullets (was 6-10). Don't repeat entries already in the API & integrator changes section above. - Restructure the API & integrator changes section into four sub-headers in fixed order: Breaking, Behaviour changes, Additive, Deprecations. Omit empty sub-headers. Bullets no longer repeat the label inline. - Pure documentation entries (e.g. "OpenAPI schema added for X") now route to Additive instead of "Other changes / Improved". - Add a third mode: breaking-change fast-path. Takes a list of PR URLs (typically from the daily breaking-change workflow), customer-voice rewrites them, and appends to the current month's Breaking sub-header. Surfaces mis-labeled PRs to the caller rather than silently demoting them into Behaviour changes. - Distinguish interactive (user-driven) mode from automated CI mode: interactive keeps the draft -> review -> write handshake, automated writes directly and lets the workflow's PR review replace per-entry review. Changelog (src/content/docs/changelog.md): - Reformat the May 2026 section to demonstrate the new sub-header layout. Older months left in their original format -- they get rebuilt naturally on the next incremental run. Workflows (.github/workflows/): - changelog-weekly.yml: Mon 08:00 UTC cron, calls the skill in incremental mode, opens a PR for review (changelog/auto-weekly). - changelog-breaking.yml: daily 09:00 UTC cron, scans saas + hub for PRs labeled changelog:breaking merged in the last 24h, calls the skill in fast-path mode, opens a PR for review (changelog/auto-breaking). Both workflows invoke the skill via headless claude --print so the rewriting logic stays in one place. Untrusted PR titles/URLs are plumbed through env vars (not interpolated into shell run scripts directly) and printf with double-quoted expansion is used in place of unquoted-heredoc substitution to remove command-injection paths. GITHUB_OUTPUT uses a random heredoc marker to avoid PR-title-as-EOF collisions. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
/review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/content/docs/changelog.mdcovering Nov 2025 → May 2026, generated by reading merged PRs frompatchstack/saasandpatchstack/huband curating customer-facing changes into a monthly digest.### API & integrator changessection before Highlights, calling out breaking changes, behaviour changes, new endpoints, and deprecations. This was added in response to feedback that an earlier/monitorAPI change shipped without upfront integrator communication.:::note[Integrating with our APIs?]callout points readers at those sections whenever they upgrade.astro.config.mjs) after FAQ & troubleshooting..claude/skills/changelog/SKILL.mdthat auto-detects initial-backfill vs incremental-update mode (via a<!-- last-updated: YYYY-MM-DD -->marker in the file) and regenerates this page from recent merged PRs.How it was generated
886 PRs scanned across both repos over 6 months → 303 auto-dropped (deps, bots, reverts-of-bumps, infra/CI) → 309 classifier-dropped (test-only, internal observability, ADRs, scaffolding, sysadmin) → 274 customer-facing entries across 7 months → curated into ~70 monthly Highlights with the rest folded under per-month
<details>Other changes</details>disclosures.Test plan
npm run devand visit/changelog/— confirm the page renders, sidebar entry appears below FAQ,<details>blocks expand, and the:::notecallout displays correctly.🤖 Generated with Claude Code