changelog-entry

Create and update Tempo changelog entries as YAML via .chloggen workflow.

5.4k|739|Updated Jan 24, 2020
One-click install
npx skills add https://github.com/grafana/tempo --skill changelog-entry-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-entry
Source: https://github.com/grafana/tempo/tree/main/.claude/skills/changelog-entry
Command: npx skills add https://github.com/grafana/tempo --skill changelog-entry-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Tempo changelog management can be error-prone when PRs rely on a separate unreleased changelog mechanism. This skill standardizes creating or updating changelog entries using the .chloggen workflow.

Core Features & Use Cases

  • Enforces structured changelog entries per PR using .chloggen
  • Prevents direct edits to unreleased CHANGELOG.md; replaces them with YAML entries
  • Validates, previews, and stages changes to ensure consistency across releases

Quick Start

Create a new YAML changelog entry for the current PR using the .chloggen workflow.

Frequently Asked Questions about changelog-entry

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

FAQPage Schema
How do I create a Tempo changelog entry for a PR using chloggen?

To create a Tempo changelog entry, use the .chloggen workflow to generate a structured YAML file instead of editing CHANGELOG.md directly. This enforces field guidance and validation to ensure consistent release notes for unreleased changes.

Why should I use YAML files for Tempo release notes instead of editing CHANGELOG.md?

Editing CHANGELOG.md directly is error-prone for unreleased changes. Using YAML entries via the .chloggen workflow standardizes the process, validates fields, and stages changes to ensure consistency across Tempo releases.

Can I preview chloggen YAML entries before finalizing a Tempo release?

Yes, the .chloggen workflow allows you to validate, preview, and stage YAML changelog entries. This ensures the generated release notes are consistent and correct before the changes are officially released.

Does the Tempo PR workflow require chloggen for all unreleased changes?

Yes, PRs with unreleased changes must document them using .chloggen YAML entries. This replaces direct CHANGELOG.md edits and enforces structured field guidance for consistent release notes.

What happens if I directly edit CHANGELOG.md instead of using chloggen YAML?

Directly editing CHANGELOG.md bypasses the .chloggen workflow's validation and field guidance. You must use YAML entries to ensure your unreleased changes are properly staged and validated for Tempo release notes.