Changelog overhaul: unify entry source, aggregate weekly releases - #456
Draft
laugharn wants to merge 2 commits into
Draft
Changelog overhaul: unify entry source, aggregate weekly releases#456laugharn wants to merge 2 commits into
laugharn wants to merge 2 commits into
Conversation
Replaces the paused template-rollout-log with a single changelog source at apps/docs/content/changelog that serves both the docs changelog page and the update-shop upgrade manifest. - Add apps/docs/content/changelog/ entry storage (one .md per change with frontmatter + Summary/Why it matters/Apply when/Safe to skip when/Validation) - Add ChangelogContent server component: reads entries, groups by ISO week of introducedOn, renders weekly releases via Streamdown - Add docs changelog page (content/docs/changelog.mdx) + sidebar entry - Rewire update-shop skill to fetch apps/docs/content/changelog; drop template-version.json and the bundled-fallback - Sync update-shop.mdx via sync-skills.ts - Replace root AGENTS.md paused-rollout notice with an advisory changelog-worthiness check for PRs touching apps/template - Delete packages/plugin/template-rollout-log/ and template-version.json (nuke the past, no backfill) Decisions: unify human + machine source, aggregate releases derived from introducedOn (no per-PR releases, no release manifest), no backfill, advisory rule only (no CI enforcement).
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Remove the description and intro paragraph from the changelog page; keep only the ChangelogContent component - Rewrite ChangelogContent to render a flat reverse-chronological list of entries with no release grouping (was grouped by ISO week) - AGENTS.md: drop the invented 'weekly' cadence from the advisory rule; keep aggregate + no per-PR releases
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
1 participant
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
Replaces the paused
template-rollout-logwith a single changelog source that serves both the docs changelog page and theupdate-shopupgrade manifest.Decisions
update-shop(no more human changelog vs. machine rollout-log fork).introducedOnon the changelog page; no per-PR releases, no release manifest to maintain.packages/plugin/template-rollout-log/andtemplate-version.json; no backfill of the gap.AGENTS.md.Changes
apps/docs/content/changelog/— new entry storage (one.mdper change: frontmatter + Summary / Why it matters / Apply when / Safe to skip when / Validation)._template.mddocuments the format and is excluded from rendering.apps/docs/components/changelog-content.tsx— async server component that reads entries, parses frontmatter (hand-rolled parser, zod-validated), groups by ISO week ofintroducedOn, sorts desc, renders weekly release headers + entries (title, change-type badge, PR link, date) viaStreamdown.apps/docs/content/docs/changelog.mdx— the changelog page;ChangelogContentregistered inmdx-components.tsx; added to the sidebar incontent/docs/meta.json.packages/plugin/skills/update-shop/SKILL.md— rewired to fetchapps/docs/content/changelog; droppedtemplate-version.json; removed the bundled-fallback (no bundled copy anymore); renamed rollout-log → changelog.introducedOn/changeKey/rollout-state.jsonsemantics unchanged → downstream state stays compatible.apps/docs/content/docs/skills/update-shop.mdx— synced vianpx tsx scripts/sync-skills.ts.apps/docs/content/docs/getting-started/extending-with-agents.mdx— rollout-log wording → changelog.AGENTS.md— replaced the paused-rollout notice with an advisory changelog-worthiness check for PRs touchingapps/template(concrete include/exclude criteria, entry format, same-PR landing, aggregate-not-per-PR).packages/plugin/template-rollout-log/andpackages/plugin/template-version.json.Verification
pnpm build(apps/docs): exit 0;/en/docs/changelogprerendered as SSG; AI-readable routes auto-picked it up (/en/llms.mdx/changelog,/en/og/changelog/image.png).Week of …), entry title + change-type badge +#999PR link, and all five body sections rendered; empty state confirmed when only_template.mdpresent. Temp entry removed.pnpm typecheck: exit 0.oxfmt --checkon all touched files: clean.oxlint: 0 errors (1 pre-existing unrelated warning inog/[...slug]/route.tsx).Out of scope (intentional)
AGENTS.mdonly.Changelog entry
None — this PR touches docs/plugin/AGENTS.md only, not
apps/template, so under the new rule it is not changelog-worthy.