prowler-changelog
Prowler-changelog automates changelog management across UI, API, MCP Server, and SDK components using a fragment-based system that prevents merge conflicts on concurrent PRs. Each change gets its own fragment file under `changelog.d/` directories, which compile into versioned `CHANGELOG.md` files at release time. The skill enforces semantic versioning rules, validates fragment format, and requires explicit confirmation before any changelog edits.
Prowler-changelog manages changelog entries for Prowler components using keepachangelog format and fragment files.
AI-generated summary based on this skill's SKILL.md
Install
prowler-cloud/prowler/prowler-changelog · repository language: Python
git clone https://github.com/prowler-cloud/prowler
cp -r prowler/skills/prowler-changelog ~/.claude/skills/prowler-changelognpx skillfed install prowler-cloud/prowler/prowler-changelogFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I add a changelog entry for a Prowler PR?
Prowler-changelog requires you to create a fragment file in the `changelog.d/` directory rather than editing `CHANGELOG.md` directly. Each fragment represents one logical change and uses the naming format `{slug}.{type}.md`, where `{slug}` is a short identifier (e.g., `fix-auth-bug`) and `{type}` is one of: `added`, `fixed`, `changed`, `deprecated`, `removed`, or `security`. Write your changelog entry as prose in the fragment file, then commit it with your PR. The fragment-based system prevents merge conflicts when multiple PRs land concurrently.
What is the prowler changelog fragment naming convention?
Prowler-changelog fragments follow the pattern `{slug}.{type}.md` under `changelog.d/` directories. The slug should be lowercase, hyphen-separated, and descriptive (e.g., `aws-s3-permissions`, `cli-output-format`). The type must be one of: `added`, `fixed`, `changed`, `deprecated`, `removed`, or `security`. For example: `aws-s3-permissions.security.md` or `cli-output-format.changed.md`. Each component (UI, API, MCP Server, SDK) maintains its own `changelog.d/` directory with this same convention.
How does prowler changelog compilation workflow work?
Prowler-changelog compiles fragments into versioned `CHANGELOG.md` files at release time. During development, fragments accumulate in `changelog.d/` directories across components. At release, the system collects all fragments, groups them by type (added, fixed, security, etc.), and generates a new version section in `CHANGELOG.md` following semantic versioning rules. Fragments are then removed from `changelog.d/`, and the compiled changelog is committed. This workflow ensures clean version history while preventing merge conflicts during active development.
What should I do if I need to fix a changelog entry already released?
Prowler-changelog requires explicit confirmation before editing already-released changelog entries in `CHANGELOG.md`. You cannot retroactively modify compiled changelog sections without authorization. Instead, create a new fragment in `changelog.d/` documenting the correction as a separate change entry. This maintains an audit trail and ensures transparency. Contact your release manager or follow your project's policy if you need to amend historical changelog content.
What are the changelog entry prose conventions for Prowler?
Prowler-changelog fragments should contain clear, concise prose describing the change from a user perspective. Each entry typically starts with a verb (e.g., 'Add', 'Fix', 'Improve') and explains what changed and why. Keep entries brief but informative—aim for one to three sentences. Avoid technical jargon when possible; focus on impact. The fragment content is prose-only; do not include metadata, version numbers, or formatting beyond standard markdown. The system validates fragment format and enforces these conventions during PR checks.
Can I skip the changelog requirement for my Prowler PR?
Prowler-changelog enforces changelog entries as a PR gate, but you can skip the requirement by applying the `no-changelog` label to your PR. Use this label only for changes that do not affect end users—such as internal refactoring, CI/CD updates, or documentation fixes. Most feature additions, bug fixes, and security patches require a fragment. If your PR is blocked by the changelog gate, either create the appropriate fragment or request the `no-changelog` label if the change truly warrants exemption.
SKILL.md
rendered from the published skill — quoted content, verbatim
How changelog entries work: fragments
A PR never edits unreleased CHANGELOG.md content directly; use fragments instead. Released-block typo/correction fixes are the only direct-edit exception and are described below. For regular entries, add one small fragment file per entry under the component's changelog.d/ directory. Fragments are compiled into the component's CHANGELOG.md at release time (deleting the consumed fragments), so concurrent PRs never conflict on the changelog.
| Component | Fragments directory | Compiled file
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 2 files
skills/prowler-changelog/SKILL.md
skills/prowler-changelog/assets/entry-templates.md