stable-release-prep

Prepares Ansible collection release branches with version bumps and changelog generation.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires antsibull-changelog, ansible-core, pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve? Preparing an Ansible collection release on a stable branch involves many error-prone manual steps: creating a prep branch, bumping galaxy.yml, writing a release summary fragment, and running antsibull-changelog correctly. This Skill automates that sequence and fixes known antsibull-changelog output bugs. ## Core Features & Use Cases - Automated release branch preparation: Creates a prep_vX.Y.Z branch, updates the galaxy.yml version, and validates that the new version is higher than the current one. - Changelog generation: Auto-generates a properly formatted release summary fragment and runs antsibull-changelog to produce CHANGELOG.rst and changelog.yaml, with optional custom release dates. - Post-generation validation: Detects and fixes common antsibull-changelog bugs such as YAML indentation errors, overlong release_summary lines, and stray .plugin-cache.yaml files. - Use Case: After analyzing pending changes on stable-1 of the amazon.aws collection, run this Skill to create prep_v1.0.1, bump the version, and generate a lint-clean changelog ready for a release PR. ## Quick Start Prepare release version 1.0.1 from the stable-1 branch of this Ansible collection and generate the changelog.

Frequently Asked Questions about stable-release-prep

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

FAQPage Schema
How do I prepare an Ansible collection release on a stable branch?▼

Create a prep_vX.Y.Z branch from the stable branch, bump the version in galaxy.yml, add a release summary fragment, then run antsibull-changelog release with the target version. This Skill automates all of these steps in sequence.

How to generate a changelog for an Ansible collection with antsibull-changelog?▼

Run antsibull-changelog release --version X.Y.Z inside the collection directory. It processes fragment files in changelogs/fragments, updates CHANGELOG.rst and changelog.yaml, and deletes the processed fragments.

Can I set a custom release date in antsibull-changelog?▼

Yes, pass --date YYYY-MM-DD to the antsibull-changelog release command. This is useful for future-dated releases, backdating recreated releases, or coordinating releases across multiple collections.

Why does ansible-lint fail on changelog.yaml after antsibull-changelog release?▼

antsibull-changelog has a known bug that generates incorrect YAML indentation, such as 4-space list items under fragments or modules. Fix indentation across the entire file, then validate with ansible-lint --offline changelogs/changelog.yaml.

What are the prerequisites for running an Ansible collection release prep?▼

You need Python 3.8 or later, a git repository with a configured upstream remote, a clean working tree on the stable branch, and at least one changelog fragment. antsibull-changelog and ansible-core are installed automatically in a virtual environment.