agentleFS
madeinoz67madeinoz67/madeinoz-knowledge-system/.claude/skills/release/SKILL.md

release

Skill3 starsChanged 10 months agoMITView on GitHub

Release automation skill for version bumping and tagging. Use when creating a new release, bumping version, tagging release, pushing release tag, or synchronizing version numbers across files. Handles package.json, README.md, SKILL.md, Dockerfile, and docker-compose files.

  • Commits and pushes

193 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-agent-adapter, changelog-style and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    create-agent-adapter

    Technical guide for creating a new Paperclip agent adapter. Use when building a new adapter package, adding support for a new AI coding tool (e.g. a new CLI agent, API-based agent, or custom process), or when modifying the adapter system. Covers the required interfaces, module structure, registration points, and conventions derived from the existing claude-local and codex-local adapters.

    Also in 5 projects that use this

  • GrinvSkill

    changelog-style

    Turn a commit range into CHANGELOG.md entries following common-changelog style. Use when finishing a PR or cutting a release, to write/fix the [Unreleased] section's entries — moving [Unreleased] under a new dated version heading is a separate, automated step (see the release skill / scripts/sync-version.ts), not this skill's job.

    Also in 4 projects that use this

  • GrinvSkill

    docs-consistency-check

    Check README/manifest.json/server.json/CHANGELOG.md/AGENTS.md and docs/*.md for drift against the actual registered tools and source. Use after adding, renaming, or removing a tool, or as part of a live-audit pass.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    component-release

    Prepares a verifiable Agent Landing Zone UI release. Use for release branches, VERSION, changelog entries, tags, release notes, and compatibility evidence; never publish without explicit human approval.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    documentation-consistency

    Keeps AI Landing Zone contributor, user, and operator documentation aligned with shipped Bicep behavior. Use for parameters, defaults, outputs, topology, deployment flow, operations, or releases.

    Also in 8 projects that use this

  • rivet-devSkill

    launch-graphics

    Generate agentOS marketing/launch graphics (launch & social heroes, code-snippet cards) from the committed generators in docs-internal/graphics. Use when asked to make, update, or render an agentOS launch image, social image, "agentOS Apps" graphic, or technical code-snippet image.

    Also in 3 projects that use this

  • +3 more from Grinv

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 183 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when:

    line 14
  2. Very specific:

    Note: All other docker-compose files use :latest tag and do NOT need updates.

    line 54
  3. Distinctive:

    Before creating a release, verify:

    line 63
  4. Distinctive:

    After pushing the tag:

    line 135
  5. Distinctive:

    Ensure all version files use the exact same version string:

    line 170

“Common” is measured: kept by at least 6 in 10 of the 183 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release Automation Skill

Purpose

Automate the release process for the Madeinoz Knowledge System, including version synchronization across all files, git tagging, and triggering the CI workflow.

When to Use

Use this skill when:

  • Creating a new release (major, minor, or patch version)
  • Bumping the version number
  • Tagging a release commit
  • Pushing a release to trigger CI workflow
  • Synchronizing version numbers across multiple files

Version Sync Locations

The following files MUST be updated with the new version:

Primary Version Files

  1. package.json (line 3)
    "version": "X.Y.Z"
  2. docker/Dockerfile (line 8)
    LABEL version="X.Y.Z"
  3. README.md (line 6)
    pack-id: madeinoz67-madeinoz-knowledge-system-core-vX.Y.Z
  4. src/skills/SKILL.md (line 3)
    version: X.Y.Z

Production Docker Compose (Manual Update)

  1. src/skills/server/docker-compose-production.yml (line 85)
    image: ghcr.io/madeinoz67/madeinoz-knowledge-system:X.Y.Z

Note: All other docker-compose files use :latest tag and do NOT need updates.

Do NOT Edit

  • CHANGELOG.md - Auto-generated by git-cliff workflow
  • Modifying this file will conflict with automated changelog generation

Pre-Release Checklist

Before creating a release, verify:

# 1. Check you're on main branch
git branch --show-current  # Should output: main

# 2. Pull latest changes
git pull origin main

# 3. Verify working tree is clean (no uncommitted changes)
git status  # Should show: "nothing to commit, working tree clean"

# 4. Verify latest CI passed
gh run list --limit 1  # Check status is "completed success"

Release Workflow

Step 1: Update Version Numbers

Manually edit the version files listed above. For example, bumping from 1.8.0 to 1.9.0:

# Edit package.json
# Edit docker/Dockerfile
# Edit README.md
# Edit src/skills/SKILL.md
# Edit src/skills/server/docker-compose-production.yml

Step 2: Commit Version Changes

git add package.json docker/Dockerfile README.md src/skills/SKILL.md src/skills/server/docker-compose-production.yml
git commit -m "chore: bump version to X.Y.Z"

Step 3: Create Annotated Tag

# Single-line description
git tag -a vX.Y.Z -m "Release vX.Y.Z"

# OR multi-line description (opens editor)
git tag -a vX.Y.Z

In the editor, use this format:

Release X.Y.Z

Summary of what's in this release:
- Feature one
- Bug fix two
- Improvement three

Step 4: Push Tag to Trigger CI

git push origin vX.Y.Z

This triggers the CI workflow which:

  • Generates changelog from git-cliff
  • Updates CHANGELOG.md on main branch
  • Builds and pushes multi-arch Docker image to GHCR
  • Creates GitHub Release with formatted release notes
  • Deploys documentation to GitHub Pages

Verification

After pushing the tag:

# Watch workflow run
gh run watch

# Confirm release created
gh release view vX.Y.Z

# Verify Docker image on GHCR
# https://github.com/madeinoz67/madeinoz-knowledge-system/pkgs/container/madeinoz-knowledge-system

Common Pitfalls

DO NOT Use gh release create Directly

❌ Wrong: gh release create vX.Y.Z --notes "Release notes"

This creates the tag via GitHub API without triggering the CI workflow. The release job will never run, leaving a broken release (no Docker image pushed, no docs deployed).

✅ Correct: git push origin vX.Y.Z

This triggers the push event for the tag, which runs the CI workflow.

DO NOT Edit CHANGELOG.md

❌ Wrong: Manually editing CHANGELOG.md

This file is auto-generated by git-cliff during the CI workflow. Manual edits will be overwritten.

✅ Correct: Use conventional commit messages. The changelog is generated from commit history.

Version Inconsistency

Ensure all version files use the exact same version string:

  • package.json: "version": "1.9.0"
  • Dockerfile: LABEL version="1.9.0"
  • README.md: pack-id: madeinoz67-madeinoz-knowledge-system-core-v1.9.0"
  • SKILL.md: version: 1.9.0

Production Compose Version

The docker-compose-production.yml file pins specific versions. Remember to update this file when releasing, as it's used for production deployments.

Release Types

TypeExampleWhen
Major1.8.0 → 2.0.0Breaking changes
Minor1.8.0 → 1.9.0New features, backward compatible
Patch1.8.0 → 1.8.1Bug fixes, small improvements

Quick Reference

# Full release workflow (replace X.Y.Z with actual version)
# 1. Edit version files
vim package.json docker/Dockerfile README.md src/skills/SKILL.md src/skills/server/docker-compose-production.yml

# 2. Commit changes
git add package.json docker/Dockerfile README.md src/skills/SKILL.md src/skills/server/docker-compose-production.yml
git commit -m "chore: bump version to X.Y.Z"

# 3. Create annotated tag
git tag -a vX.Y.Z -m "Release vX.Y.Z"

# 4. Push tag to trigger CI
git push origin vX.Y.Z

# 5. Verify
gh run watch
gh release view vX.Y.Z

Related Documentation

  • CLAUDE.md - Release checklist (critical section)
  • .github/workflows/ci.yml - CI workflow definition
  • docs/reference/releases.md - Release documentation

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.