changelog-fragment

Creates and updates changelog fragments for Ansible collections with PR URLs.

8|7|Updated Feb 14, 2023
One-click install
npx skills add https://github.com/eclipse-slm/slm --skill changelog-fragment-eclipse-slm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog-fragment
Source: https://github.com/eclipse-slm/slm/tree/main/.agents/skills/changelog-fragment
Command: npx skills add https://github.com/eclipse-slm/slm --skill changelog-fragment-eclipse-slm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Maintaining changelog entries for Ansible collections requires manually writing YAML fragment files with the correct change type, component names, and PR links, which is error-prone and easy to forget during development. ## Core Features & Use Cases - Fragment Creation: Generates changelog fragment files in changelogs/fragments/ with the correct change type (bugfixes, minor_changes, breaking_changes, etc.), component name, and description. - Automatic Change Analysis: Inspects the current git branch's changed files and commits to suggest the change type, affected components, and description. - PR URL Updates: After a pull request is created, finds fragments containing XXXX placeholders and updates them with the real PR URL, then commits and pushes the changes. - Use Case: You fixed a bug in the ec2_instance module and opened PR 1234. The skill creates 1234-ec2-instance-tag-fix.yml with a properly formatted bugfixes entry linking to your PR. ## Quick Start Create a changelog fragment for my current branch changes in this Ansible collection.

Frequently Asked Questions about changelog-fragment

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

FAQPage Schema
How do I create a changelog fragment for an Ansible collection?▼

Create a YAML file in the changelogs/fragments directory with a change type key like bugfixes or minor_changes, followed by entries listing the component, description, and PR URL. This skill automates filename generation, change type detection, and formatting.

How to update changelog fragments with a PR number after creating a pull request?▼

Use the update-pr-url mode with your PR number. It scans changed files in the current branch for fragments containing XXXX placeholders or missing GitHub URLs, inserts the real PR link, and commits and pushes the updates.

What change types are supported in Ansible changelog fragments?▼

Supported sections are bugfixes, minor_changes, major_changes, breaking_changes, deprecated_features, removed_features, security_fixes, and trivial. Each entry should describe the change from a user's perspective and end with the PR URL.

Does the changelog fragment skill work outside Ansible collections?▼

It is designed for repositories with a changelogs/fragments directory, which is the convention used by Ansible collections. It can optionally read namespace and name from galaxy.yml but works with any repository following the same fragment structure.

When should I not use changelog fragments?▼

Do not use fragments to generate the full release changelog; that is handled by the release process which consumes the fragments. Fragments are only for documenting individual changes tied to pull requests.