create-changelog-announcement_skill

Overview

This skill creates and publishes changelog announcements for new features, improvements, and bug fixes. It runs the full workflow: detailed changelog page, summary in the main changelog, sidebar announcement JSON, roadmap update, and social announcement drafts. The skill enforces project naming, frontmatter, and writing style rules to ensure consistent, build-safe releases.

How this skill works

I collect required details (feature name, clear description, semantic version, release date, media, and related docs). I generate three coordinated artifacts: a detailed MDX entry in docs/blog/entries, a 1–2 paragraph summary at the top of docs/blog/main.mdx, and a sidebar JSON card in web/oss/src/components/SidebarBanners/data/changelog.json. I also update the roadmap, prepare social announcements, and run a documentation build checklist to catch frontmatter, linking, and syntax issues.

When to use it

• Announcing a shipped feature or bug fix that needs public documentation
• Preparing release notes or changelog entries for a specific version
• Adding a sidebar banner to notify users of a new capability
• Updating roadmap items from in-progress to shipped
• Drafting coordinated social posts for a release

Best practices

• Always confirm the semantic version before proceeding; ask “Which version is this changelog entry for?” if unclear
• Use kebab-case slugs under 60 characters and sidebar IDs like changelog-YYYY-MM-DD-feature-slug
• Write in active voice, short sentences, and user-focused benefits ("You can now...")
• Include relative documentation links when they exist; ask to create missing docs if needed
• Add media placeholders or ask for YouTube URLs/screenshots before finalizing the detailed entry
• Run docs build and the QA checklist to ensure frontmatter, JSON, and links are valid

Example use cases

• Ship a new observability feature and produce a detailed MDX article plus sidebar banner and social drafts
• Release a bug-fix patch and add a concise summary entry tied to a specific vX.Y.Z release
• Move a roadmap item from inProgressFeatures to shippedFeatures and attach the changelog path
• Close a related GitHub discussion after shipping and note the closure in release notes
• Prepare LinkedIn, Twitter, and Slack messages that match the changelog tone and avoid AI clichés