bk-ship

Automates release preparation by verifying builds, updating CHANGELOG.md, and generating documentation artifacts from specifications.

Updated Mar 3, 2026
One-click install
npx skills add https://github.com/dikini/knot --skill bk-ship
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bk-ship
Source: https://github.com/dikini/knot/tree/main/.agents/skills/bk-ship
Command: npx skills add https://github.com/dikini/knot --skill bk-ship

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the complex and error-prone process of preparing and releasing software versions, ensuring consistency and reducing manual effort.

Core Features & Use Cases

  • Automated Verification: Runs pre-release checks to ensure quality and compliance.
  • Changelog Management: Updates CHANGELOG.md with new version details.
  • Documentation Generation: Optionally creates release notes, API references, and guides from specifications.
  • Artifact Creation: Organizes release artifacts in a structured directory.
  • Use Case: When you're ready to ship version 1.2.0, you can run this skill to automatically verify the build, update the changelog, generate documentation, and prepare all necessary files for deployment.

Quick Start

Prepare the release for version 1.2.0 by running the ship skill with the minor scope.

Frequently Asked Questions about bk-ship

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

FAQPage Schema
How do I automate software release preparation and changelog updates?

Automate software release preparation by using a structured workflow to run verification checks, update CHANGELOG.md, and generate documentation. This ensures release readiness while reducing manual effort for versioning patch, minor, and major scopes.

What is the best way to manage versioning across patch, minor, and major releases?

Manage versioning across patch, minor, and major scopes through an automated release workflow that updates changelogs and organizes artifacts. This structured approach maintains consistency and ensures build quality before deployment.

Can I generate API references and release notes from specifications automatically?

Generate API references, release notes, and guides directly from specifications during the release process. This optional documentation creation organizes artifacts in a structured directory to streamline deployment.

How do I verify release readiness before deploying a new software version?

Verify release readiness by running automated pre-release checks within a structured workflow. This performs build verification and compliance validation to ensure quality before updating changelogs and generating artifacts.

Does automated changelog management work without external dependencies?

Automated changelog management works without external dependencies by using internal references to update CHANGELOG.md. It structurally organizes version details and documentation artifacts independently for consistent releases.