review-changelog

Reviews pending changelog entries and guides completion of missing fields.

1|1|Updated Dec 1, 2025
One-click install
npx skills add https://github.com/zenml-io/zenml-changelog --skill review-changelog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-changelog
Source: https://github.com/zenml-io/zenml-changelog/tree/main/.claude/skills/review-changelog
Command: npx skills add https://github.com/zenml-io/zenml-changelog --skill review-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of finalizing automated changelog entries by guiding users through reviewing and completing placeholder information, ensuring accuracy and completeness.

Core Features & Use Cases

  • Review and Update: Assists in verifying and editing automatically generated changelog entries.
  • Placeholder Resolution: Helps fill in missing details like feature images, video URLs, and documentation links.
  • Use Case: After a new release, the automation creates a PR for changelog updates. This Skill helps a product manager or technical writer review each entry, add relevant screenshots, link to new docs, and ensure the audience and labels are correct before merging.

Quick Start

Use the review changelog skill to help complete the new changelog entries in the current PR.

Frequently Asked Questions about review-changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I complete automated changelog entries generated by a PR process?

To complete automated changelog entries, review the generated PR content and fill in placeholder URLs, select appropriate audience labels, and add feature images or video links. This ensures entries are accurate and ready for publication by cross-referencing with existing updates.

What is the best way to review release notes before publication?

The best way to review release notes is to cross-reference new entries with existing changelog records, verify placeholder details like documentation links, and use preview links to check formatting accuracy before merging the PR.

How do I add feature images and video links to product update entries?

To add feature images and video links to product update entries, locate the placeholder URLs in the automated changelog PR and replace them with the direct media links to ensure the content is complete for publication.

Can I use this to select appropriate audience labels for changelog updates?

Yes, you can use this to select appropriate audience labels for changelog updates. The process guides you through verifying automatically generated entries and assigning the correct audience and label classifications before merging.

Does the changelog review process provide preview links for documentation updates?

Yes, the changelog review process provides preview links. It cross-references new entries with existing content and generates preview links so you can verify that all documentation updates and feature details render accurately before publication.

What should I do if my automated changelog PR has missing placeholder URLs?

If your automated changelog PR has missing placeholder URLs, you need to resolve them by adding the correct documentation links, feature images, or video URLs. The review process guides you through filling these gaps to ensure publication readiness.