skills.rest
jparkerweb
jparkerwebCOMMUNITY
Explore all skills by this author →
Website𝕏@jparkerwebGitHub

ai-assist-changelog-bump

Validate CHANGELOG.md against main and compute semver bumps for package.json.

87|12|Updated Sep 17, 2024
Search Tags:#automation#git#changelog#versioning#release#package.json#semver
One-click install
npx skills add https://github.com/jparkerweb/ai-assist-skills --skill ai-assist-changelog-bump
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ai-assist-changelog-bump
Source: https://github.com/jparkerweb/ai-assist-skills/tree/main/skills/ai-assist-changelog-bump
Command: npx skills add https://github.com/jparkerweb/ai-assist-skills --skill ai-assist-changelog-bump

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures the published CHANGELOG.md reflects the correct version by deriving it from main, aligns with package.json, and prevents PRs with misaligned versioning.

Core Features & Use Cases

  • Validate the latest version in main's changelog and detect drift on the branch.
  • Compute the correct semver bump based on changes, and update CHANGELOG.md and package.json accordingly.
  • Aid release readiness by guiding the user through drafting or adjusting entries with Keep a Changelog conventions.

Quick Start

Run a local test to validate and align the branch's changelog version with main and update package.json if needed.

Frequently Asked Questions about ai-assist-changelog-bump

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

FAQPage Schema
How do I automatically align my changelog version with package.json before a release?▼

To align your changelog version with package.json, this skill derives the correct released version from the main branch and updates your branch's CHANGELOG.md and package.json to match. It computes the proper semver bump based on classified changes.

What is the best way to calculate the correct semver bump for a new release entry?▼

Calculating the correct semver bump involves classifying changes in your branch against the latest version on main. This skill automatically categorizes your changes and computes the appropriate major, minor, or patch version increment for your changelog.

How do I validate changelog entries against the main branch before merging a PR?▼

Validating changelog entries against the main branch prevents versioning drift. This skill detects mismatches between your branch's CHANGELOG.md and the main branch, guiding you through adjustments to ensure PR readiness using Keep a Changelog conventions.

Does this changelog validation tool require any dependencies to run?▼

No dependencies are required to run this changelog validation tool. It operates independently to verify your CHANGELOG.md entries, align your package.json, and prompt for confirmation before writing any updates.

Why does my package.json version drift from the released changelog version?▼

Package.json version drift occurs when branch changes are not synchronized with the main branch's released version. This skill resolves the issue by deriving the correct version from main and aligning both your package.json and changelog accordingly.

Related Skills

Explore More Software Engineering Skills→
ablyably
5

release

Create a release branch and update version metadata for semver releases.

Official
Advanced
ereticaeretica

build-and-release

Automate version bumping, commit, tag, and push to GitHub for releases.

Community
Advanced
coff33ninjacoff33ninja

release-changelog

Automates SemVer-Compliant release workflows including bumping versions, updating changelogs, and triggering CI/CD pipelines for diverse programming languages and systems.

Community
Advanced
SfzmangoSfzmango
1

release-notes

Compile release notes from git commit ranges and merged pull requests.

Community
Advanced