Skip to main content
skill CX Codex

prowler-changelog — Claude Code skill: what it does, how to install

This skill manages Prowler changelog fragments for component changes and pull requests. It helps keep release notes in the required format.

Apache-2.0 ★ 15,302 updated 2026-10-25

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add prowler-cloud/prowler --skill prowler-changelog -a claude-code
Open on GitHub

What prowler-changelog does

The skill maps changed Prowler paths to a component and prepares a separate file in its changelog.d/ directory. Fragment names use <slug>.<type>.md; the type selects a Keep a Changelog section such as added, changed, fixed, or security. The file should contain the entry text only, with no pull request link or final period.

At release time, fragments are compiled into the component’s CHANGELOG.md. The relevant locations are ui/changelog.d/, api/changelog.d/, mcp_server/changelog.d/, and prowler/changelog.d/. The skill can inspect Git paths and pending fragments while preparing the change. It must ask for explicit approval before creating or editing a fragment or CHANGELOG.md, so an unanswered request leaves the files untouched.

What it helps with

  • add a changelog entry for a changed component
  • map a change to the correct changelog section
  • check whether a pull request needs a fragment
  • write an entry without a pull request link or trailing period

Example prompts for the agent

  • For this PR, identify the affected Prowler component and show the proposed fragment path and text before writing anything
  • Check whether my api/ changes need a file in api/changelog.d/, then ask for confirmation
  • Review the format for a prowler/CHANGELOG.md entry and do not edit files until I approve it

How to install prowler-changelog

1Skills CLI (Vercel)

npx skills add prowler-cloud/prowler --skill prowler-changelog -a claude-code

2Manually: put the files in place

~/.claude/skills/prowler-changelog/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/prowler-changelog/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about prowler-changelog

How do I install prowler-changelog in Claude Code?

Run npx skills add prowler-cloud/prowler --skill prowler-changelog -a claude-code, then check ~/.claude/skills/prowler-changelog/SKILL.md.

What does prowler-changelog do?

It manages component-level changelog fragments for Prowler. The skill identifies the affected area, chooses an entry type, and prepares content that can later be compiled into CHANGELOG.md.

Why does the skill ask for approval before editing?

It must show the target path, exact entry text, and reason before changing a fragment or CHANGELOG.md. It does not write the change without explicit user confirmation.

Source text

SKILL.md · Apache-2.0
---
name: prowler-changelog
description: >
  Manages changelog entries for Prowler components following keepachangelog.com format.
  Trigger: When creating PRs, adding changelog entries, or working with any CHANGELOG.md file in ui/, api/, mcp_server/, or prowler/.
license: Apache-2.0
metadata:
  author: prowler-cloud
  version: "2.0"
  scope: [root, ui, api, sdk, mcp_server]
  auto_invoke:
    - "Add changelog entry for a PR or feature"
    - "Update CHANGELOG.md in any component"
    - "Create PR that requires changelog entry"
    - "Review changelog format and conventions"
allowed-tools: Read, Edit, Write, Glob, Grep, Bash
---

## 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 |
|-----------|---------------------|---------------|
| UI | `ui/changelog.d/` | `ui/CHANGELOG.md` |
| API | `api/changelog.d/` | `api/CHANGELOG.md` |
| MCP Server | `mcp_server/changelog.d/` | `mcp_server/CHANGELOG.md` |
| SDK | `prowler/changelog.d/` | `prowler/CHANGELOG.md` |

"What's unreleased" = "what's in `changelog.d/`". The compiled `CHANGELOG.md` files contain only released versions.

## Fragment filename

```text
<slug>.<type>.md
```

- `<slug>` is free-form (`[A-Za-z0-9][A-Za-z0-9._-]*`), chosen by the author, ideally descriptive of the change (e.g. `securityhub-delegated-admin`). The PR number is also a valid slug (e.g. `11259`) when it is already known; it is never required.
- `<type>` maps 1:1 to the keepachangelog sections:

| `<type>` | Section | Usage |
|----------|---------|-------|
| `added` | `### 🚀 Added` | New features, checks, endpoints |
| `changed` | `### 🔄 Changed` | Modifications to existing functionality |
| `deprecated` | `### ⚠️ Deprecated` | Features marked for removal |
| `removed` | `### ❌ Removed` | Deleted features |
| `fixed` | `### 🐞 Fixed` | Bug fixes |
| `security` | `### 🔐 Security` | Security patches, CVE fixes |

- A PR adds as many fragment files as entries it needs, freely mixing types: one file per entry. E.g. a PR touching Added, Changed and Fixed ships `kms-rotation-check.added.md` + `kms-metadata-cache.changed.md` + `kms-disabled-keys.fixed.md`, and all compile with the same PR link into their own sections.
- Several entries of the SAME type: a different slug per entry (`kms-rotation-check.added.md`, `kms-rotation-docs.added.md`).
- At least one fragment per touched component, same as the old one-entry-per-changelog rule.

## Fragment content

The file contains ONLY the entry text, exactly as it should appear in the changelog, on a single line ending with a trailing newline:

```bash
echo '`securityhub_delegated_admin_enabled_all_regions` check for AWS provider, verifying that Security Hub has a delegated administrator, is active in all opted-in regions, and has organization auto-enable on' > prowler/changelog.d/securityhub-delegated-admin.added.md
```

**Rules (same prose conventions as always):**

- **NEVER write the PR link in the text.** It is attached automatically at compile time (the compile workflow resolves the PR that added the fragment from git history). Writing `[(#NNNN)](...)` in a fragment produces a duplicated link.
- No period at the end
- Do NOT start with redundant verbs (the section header already provides the action)
- Be specific: what changed, not why (that's in the PR)
- Keep entries readable: use spaces around inline code and product names, and wrap endpoints, commands, errors, task names, and file paths in backticks
- Avoid long run-on sentences; split complex changes into one concise result plus one concise context clause

### Good fragments

```text
# ui/changelog.d/provider-search-bar.added.md
Search bar when adding a provider

# api/changelog.d/scan-dispatch-race.fixed.md
`POST /api/v1/scans` no longer intermittently fails with `Scan matching query does not exist`; scan dispatch now publishes the `scan-perform` Celery task after the transaction commits

# ui/changelog.d/node-24-bump.security.md
Node.js from 20.x to 24.13.0 LTS, patching 8 CVEs
```

### Bad fragments

```text
Fixed bug.                              # Too vague, has period, redundant verb
Add search bar                          # Redundant verb (the section already says "Added")
Search bar [(#9634)](https://github.com/prowler-cloud/prowler/pull/9634)   # NEVER include the PR link; it is added at compile time
```

## Semantic Versioning Rules

Prowler follows [semver.org](https://semver.org/):

| Change Type | Version Bump | Example |
|-------------|--------------|---------|
| Bug fixes, patches | PATCH (x.y.**Z**) | 1.16.1 → 1.16.2 |
| New features (backwards compatible) | MINOR (x.**Y**.0) | 1.16.2 → 1.17.0 |
| Breaking changes, removals | MAJOR (**X**.0.0) | 1.17.0 → 2.0.0 |

**CRITICAL:** `removed` fragments MUST only ship in MAJOR version releases. Removing features is a breaking change.

## Mandatory Human Confirmation Gate

Before creating or editing any changelog fragment or `CHANGELOG.md` file, the agent MUST stop and get explicit user confirmation. This applies even when the changelog gate is failing, the required file seems obvious, or the user asked to "fix the changelog".

Present the proposed action before writing:

1. Target fragment path (component, slug, type) or CHANGELOG.md edit.
2. Exact entry text.
3. Reason the changelog entry is needed.

Only proceed after an explicit approval such as "confirm", "approved", "sí", or equivalent. If the user rejects or does not answer, do not create or edit anything. Offer alternatives such as adding `no-changelog` when appropriate.

## Adding a Changelog Entry

### Step 1: Determine Affected Component(s)

```bash
git diff master...HEAD --name-only | grep -E '^(ui|api|mcp_server|prowler)/' | cut -d/ -f1 | sort -u
```

| Path Pattern | Component |
|--------------|-----------|
| `ui/**` | UI |
| `api/**` | API |
| `mcp_server/**` | MCP Server |
| `prowler/**` | SDK |
| Root `uv.lock` / `pyproject.toml` | SDK (the gate requires a `prowler/changelog.d/` fragment) |
| Multiple | One fragment per affected component |

### Step 2: Create the fragment(s)

```bash
echo 'Entry text describing the change' > <component>/changelog.d/<slug>.<type>.md
```

### Step 3: Check pending fragments

```bash
ls prowler/changelog.d/ api/changelog.d/ ui/changelog.d/ mcp_server/changelog.d/
```

## PR Changelog Gate

The `pr-check-changelog.yml` workflow enforces fragments:

1. **REQUIRED**: PRs touching `ui/`, `api/`, `mcp_server/`, or `prowler/` MUST add (or fix) a fragment under the corresponding `changelog.d/`
2. **VALIDATED**: added fragment filenames must match `<slug>.<type>.md` with a valid type
3. **LINTED**: fragment content must NOT contain a hand-written PR link (`[(#N)](...)`); the gate fails if one is found because the link is attached automatically at compile time
4. **SKIP**: Add `no-changelog` label to bypass (use sparingly for docs-only, CI-only changes)

## Release flow (compile)

- At release time, the `compile-changelogs` workflow (manual dispatch: `prowler_version` + `target_branch`; per-component versions are auto-derived by mirroring the Prowler version — SDK mirrors it directly, UI is `1.<minor>.<patch>`, API is `1.<minor + 1>.<patch>`, and only the MCP Server derives from its pending fragment types — with optional explicit overrides or `skip`) resolves each fragment's PR from git history, runs the compiler per component, and opens a `chore(changelog): vX.Y.Z` PR (labeled `no-changelog` and `skip-sync`) that inserts the stamped `## [X.Y.Z] (Prowler vX.Y.Z)` block into each `CHANGELOG.md` and deletes the consumed fragments. A human reviews and squash-merges it. `prepare-release.yml` then extracts the stamped sections exactly as before.
- **Minor release (X.Y.0):** compile on `master` and merge the compile PR BEFORE cutting the `v5.X` branch.
- **Patch release (X.Y.Z):** fixes are backported to `v5.X` with their fragment files (conflict-free); compile on `v5.X` and merge its PR there. The same workflow run automatically opens a second forward-sync PR against master (labeled `no-changelog` and `skip-sync`) that inserts the same stamped block under master's marker and deletes the consumed fragments, so the next minor cannot re-release them; merge it right after. Fragments that only existed on `v5.X` are skipped with a notice. No manual git is involved.
- Entries within a section are ordered by PR number ascending (approximately chronological). Do not fight this ordering.

## Fixing an already-released entry

Released version blocks in `CHANGELOG.md` are otherwise immutable, but typo/correction fixes to already-released entries are the one case where a PR edits `CHANGELOG.md` directly: make the edit and add the `no-changelog` label.

If a PR's entry shipped in the wrong released block (e.g. the PR merged after its release was cut), move the entry back to a fragment: delete it from the released block and recreate it as `<component>/changelog.d/<PR>.<type>.md` (label the PR `no-changelog` since it edits `CHANGELOG.md`).

## Compiled CHANGELOG.md format (for reference)

The compiler renders, per release, into each `CHANGELOG.md` right under the `<!-- changelog: release notes start -->` marker (never remove that marker):

```markdown
## [X.Y.Z] (Prowler vA.B.C)

### 🚀 Added

- Entry text [(#NNNN)](https://github.com/prowler-cloud/prowler/pull/NNNN)

### 🐞 Fixed

- Fix entry [(#NNNN)](https://github.com/prowler-cloud/prowler/pull/NNNN)

---
```

Section order is always: Added → Changed → Deprecated → Removed → Fixed → Security. `X.Y.Z` is the COMPONENT version; `A.B.C` is the Prowler release version. Every entry ends with its PR link; linking to `/issues/N` is forbidden (the issue↔PR mapping belongs in the PR body via `Fixes #N`).

## Resources

- **Templates**: See [assets/](assets/) for entry templates
- **keepachangelog.com**: https://keepachangelog.com/en/1.1.0/

© prowler-cloud · Apache-2.0 · prowler-cloud/prowler

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set13

The whole set →
react-19 Skill for React 19 with React Compiler: no manual memoization, server components first, ref as a prop. CX Codex +1 675installs tailwind-4 tailwind-4 is a Claude Code skill for styling with Tailwind CSS 4. It activates around className, variants, and dynamic values. CX Codex +1 617installs django-drf django-drf — a skill for building REST APIs on Django with ViewSets, serializers, and filters following Prowler standards. Use it when coding endpoints with RLS, JSON:API, and OpenAPI docs. CX Codex +1 484installs prowler-ci prowler-ci is a Claude Code skill that helps investigate GitHub Actions failures and PR validation gates in the Prowler repository. CX Codex +1 ★ 15,302repo stars prowler-docs prowler-docs sets the writing rules for Prowler documentation: brand voice, Title Case headings, MDX blocks, term handling. Useful when a tutorial or a release note has to match the project's style. CX Codex +1 ★ 15,302repo stars prowler-compliance-review prowler-compliance-review reviews pull requests adding or updating compliance frameworks in Prowler. Validates JSON schemas, detects duplicate IDs, and flags missing checks. CX Codex +1 ★ 15,302repo stars jsonapi Checks API endpoints and responses against JSON:API v1.1. Use it when building, changing, or reviewing an API. CX Codex +1 ★ 15,302repo stars prowler-compliance Handles Prowler compliance frameworks end to end: authoring the JSON, syncing with the upstream catalog, and reviewing how checks map to requirements. CX Codex +1 ★ 15,302repo stars

Project sponsors

Companies that keep this analytics open