home / skills / toilahuongg / shopify-agents-kit / release

release skill

This skill orchestrates a complete release workflow by validating tests, updating changelog, and tagging versions for seamless deployment.

npx playbooks add skill toilahuongg/shopify-agents-kit --skill release

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

987 B

---
name: release
description: Orchestrates the release process - Testing, Documentation, and Tagging. Use when preparing a new version release.
argument-hint: "[version number]"
disable-model-invocation: true
allowed-tools: Bash(npm:*), Bash(git:*)
---

# Release

Orchestrate the complete release process.

1. **Preparation**:
    * Identify the version number to release (from argument or `package.json`).

2. **Step 1: Verify (QA)**:
    * Load the `qa-specialist` agent.
    * Run available tests: `npm run test` (or equivalent).
    * **STOP** if tests fail.

3. **Step 2: Document (Writer)**:
    * Load the `technical-writer` agent.
    * Check `CHANGELOG.md`.
    * Add an entry for the new version if missing, summarizing recent commits.

4. **Step 3: Tag (Git)**:
    * Commit changes: `git add . && git commit -m "chore(release): v<VERSION>"`
    * Create tag: `git tag v<VERSION>`

5. **Completion**:
    * Notify the user that the release v<VERSION> is ready to be pushed.

Overview

This skill orchestrates the full release workflow for a new version, covering testing, documentation, and Git tagging. It centralizes verification, changelog updates, and tag creation so releases are consistent and repeatable. Use it to prepare a release candidate before pushing tags and publishing artifacts.

How this skill works

The skill first determines the release version from an argument or the project manifest (e.g., package.json). It runs the test suite through a QA specialist agent and halts on failures. If tests pass, it invokes a technical writer agent to ensure CHANGELOG.md contains an entry for the new version, adding a concise summary of recent commits when needed. Finally, it stages and commits release changes and creates a Git tag for the new version, then notifies you that the release is ready to push.

When to use it

Preparing a new semantic version release (patch, minor, major).
Before pushing tags and publishing packages to registries.
When you need an automated, repeatable release checklist.
When you want tests and documentation verified before tagging.

Best practices

Always run the skill from a clean working tree to avoid accidental commits.
Provide the explicit version argument when bumping to avoid ambiguity.
Fix failing tests before proceeding; the process stops on test failures.
Review the changelog entry added by the writer agent before committing.
Tag releases using the exact format v<VERSION> to keep tags predictable.

Example use cases

Release v1.2.0 after completing sprint work: runs tests, updates CHANGELOG.md, commits and tags v1.2.0.
Patch release for a hotfix: supply version argument, validate tests, and create a v1.2.1 tag.
Preparing a major release: ensure documentation summaries capture breaking changes before tagging.
Automated CI step that invokes the skill after merge to main, gating the tag creation on passing tests.

FAQ

What happens if tests fail?

The process stops immediately and reports the failing tests; no documentation edits or tags are created.

How is the release version determined?

The skill uses an explicit version argument if provided, otherwise it reads the version from the project manifest such as package.json.

Will the skill push commits or tags remotely?

No. The skill commits and creates a local tag, then notifies you that the release is ready to push so you control the remote update.