rootiest
b3185381c5
Verify branching tree and select the proper PR base/target to reflect the branching order.
50 lines
2.9 KiB
Markdown
50 lines
2.9 KiB
Markdown
---
|
|
name: git-publish-workflow
|
|
description: Automates branching, conventional commits, testing, and PR creation for uncommitted or staged work. Handles both independent and stacked PRs.
|
|
version: 1.2.0
|
|
user-invocable: true
|
|
author: Rootiest
|
|
---
|
|
|
|
# Git Publish & PR Workflow
|
|
|
|
## **Objective**
|
|
To provide a hands-off, end-to-end automation for moving local changes into a formal Pull Request, ensuring code quality through automated and manual verification steps, while intelligently routing Stacked PRs.
|
|
|
|
## **Execution Protocol**
|
|
|
|
### **Phase 1: Scope & Base Determination**
|
|
Before execution, check the local git state:
|
|
1. **Scope Check**: Determine the work boundary:
|
|
* **Case A (Partial):** If staged changes exist, operate **ONLY** on staged changes.
|
|
* **Case B (Full):** If no changes are staged, operate on **ALL** modified/untracked files.
|
|
2. **Base Branch Detection**: Identify the currently checked-out branch.
|
|
* **Independent PR**: If the current branch is `main` (or `master`), the new branch will be based on `main`. The PR target will be `main`.
|
|
* **Stacked PR**: If the current branch is a feature branch (e.g., `feat-a`), assume the new changes are dependent. The new branch will be created from the current branch. The PR target will be the current feature branch (NOT `main`).
|
|
* *Safety Check*: If creating a Stacked PR, output a brief terminal message stating: "Detected active feature branch. Stacking new PR on top of `[current-branch-name]`."
|
|
|
|
### **Phase 2: The "Safe-Commit" Sequence**
|
|
1. **Branching**: Generate a `kebab-case` branch name (e.g., `feat-auth-logic` or `fix-header-css`) based off the branch determined in Phase 1.
|
|
2. **Naming**: Use **Conventional Commits** for the message (e.g., `feat(ui): add logout button`).
|
|
3. **Verification**:
|
|
* Identify the project type (e.g., Rust/Cargo, Python/Poetry, Node/NPM).
|
|
* Run the primary `test`, `lint`, or `build` command.
|
|
* **Abort Policy**: If verification fails, stop the sequence and report the error. Do not push.
|
|
|
|
### **Phase 3: Remote Integration**
|
|
1. **Push**: Upload the new branch to `origin`.
|
|
2. **PR Creation**: Open a Pull Request targeting the base branch determined in Phase 1 (either `main` or the parent feature branch).
|
|
3. **Documentation**: Populate the PR description with:
|
|
* **Summary**: A high-level overview of "Why" and "What."
|
|
* **Manual Verification Checklist**: Provide a Markdown list (`- [ ]`) of 3-5 tactical steps for a human to verify the change in a live environment.
|
|
|
|
## **Constraints & Rules**
|
|
* **Atomic Commits**: If multiple distinct features are found in the scope, suggest splitting the work instead of one giant commit.
|
|
* **No Force Push**: Never use `--force` unless explicitly requested in the follow-up prompt.
|
|
* **Clean State**: Ensure the workflow ends with the user on the new branch, not the original branch.
|
|
|
|
## **Trigger Scenarios**
|
|
* User says: "Ship this."
|
|
* User says: "Make a PR for my current changes."
|
|
* Invoked via `/git-publish-workflow`.
|