ship

Merge base branch, run tests, bump version, update changelog, commit, push, and create a pull request.

Updated Sep 10, 2024
One-click install
npx skills add https://github.com/TioSavich/UMEDCTA --skill ship-tiosavich
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ship
Source: https://github.com/TioSavich/UMEDCTA/tree/main/.claude/skills/gstack/ship
Command: npx skills add https://github.com/TioSavich/UMEDCTA --skill ship-tiosavich

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ship workflow automation for code changes: detect and merge the base branch, run tests, review diffs, bump VERSION, update CHANGELOG, commit, push, and create a PR. Proactively suggests actions when asked to ship or deploy.

Core Features & Use Cases

  • Detects the current branch, merges the base into the feature branch, and runs the test suite.
  • Bumps the version, updates the changelog, commits changes, pushes, and opens a PR.
  • Proactively suggests next steps when code is ready or deployment is being considered.

Quick Start

Trigger the ship skill by saying "ship" and it will merge the base branch, run tests, update the CHANGELOG, bump VERSION, commit, push, and create a PR.

Frequently Asked Questions about ship

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

FAQPage Schema
How do I automate git merge, tests, and pull request creation for code changes?

Automating git merge, tests, and pull requests involves merging the base branch into your feature branch, running the test suite, bumping the version, updating the changelog, committing, pushing, and opening a PR in one continuous workflow.

What is the best way to update the changelog and bump the version before pushing a git branch?

Updating the changelog and bumping the version before pushing a git branch requires reviewing code diffs after merging the base branch, then automatically applying version increments and changelog entries prior to committing and creating a pull request.

Can I trigger a full ship workflow to merge and push to main automatically?

Yes, you can trigger a full ship workflow to merge and push to main automatically by prompting to "ship", "deploy", or "merge and push", which initiates the end-to-end process and proactively suggests deployment steps.

Does automated PR creation work if my feature branch has failing tests?

Automated PR creation runs the test suite after merging the base branch into your feature branch. If tests fail, the workflow halts to prevent pushing broken code and opening a pull request with errors.

When do I need an end-to-end ship workflow instead of just committing code?

You need an end-to-end ship workflow instead of just committing code when your project requires merging the base branch, passing tests, updating the changelog, bumping the VERSION, and generating a pull request before deployment.

Why does my code deployment workflow require a pull request after pushing?

Your code deployment workflow requires a pull request after pushing to ensure changes are reviewed post-merge and post-test, maintaining version control integrity by standardizing changelog updates and version bumps before integration.