Skip to content

docs(release): align guidance with hotfix publish flow#407

Merged
dev-jodee merged 2 commits intomainfrom
docs/release-flow-hotfix-guidance
Mar 27, 2026
Merged

docs(release): align guidance with hotfix publish flow#407
dev-jodee merged 2 commits intomainfrom
docs/release-flow-hotfix-guidance

Conversation

@dev-jodee
Copy link
Copy Markdown
Contributor

@dev-jodee dev-jodee commented Mar 27, 2026

Summary

  • update release section in CLAUDE.md to document both mainline and hotfix publish paths
  • update release skill guidance to avoid implying main-only publish for hotfix patches
  • update complete-release skill scope to clarify it is for mainline releases and note hotfix publish behavior

Why

The publish workflows now allow both main and hotfix/*, but guidance still implied a main-only sequence in a few places.

Test Plan

  • manual doc review for consistency with workflow guards

Open with Devin

Document branch-specific release behavior: mainline releases publish from main after merge, while hotfix releases publish from hotfix/* before merge-back. Also update Claude skill path reference.
@dev-jodee dev-jodee requested a review from amilz as a code owner March 27, 2026 18:13
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 27, 2026

📊 TypeScript Coverage Report

Coverage: 33.9%

View detailed report

Coverage artifacts have been uploaded to this workflow run.
View Artifacts

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 27, 2026

Greptile Summary

This PR aligns release documentation with the updated publish workflows that allow both main and hotfix/* refs. It restructures CLAUDE.md to clearly separate the mainline and hotfix release paths, updates both Claude skills to scope their guidance to mainline, and fixes an incorrect skill path reference (release.mdrelease/SKILL.md).\n\nKey changes:\n- CLAUDE.md: Steps 2–4 restructured into distinct mainline, hotfix, and publish-workflow sections; old step-by-step "Publish to crates.io" collapsed into a concise workflow summary; broken skill path corrected.\n- .claude/skills/release/SKILL.md: Intro and PR body template narrowed to mainline; hotfix note added.\n- .claude/skills/complete-release/SKILL.md: Description and intro scoped to mainline; Notes updated to reference hotfix path. One minor concern: the skill's trigger phrases still include \"trigger publish workflows\" without a mainline qualifier, while Steps 5 and 6 hardcode --ref main — a hotfix author who triggers the skill that way would silently publish from the wrong ref.

Confidence Score: 5/5

Safe to merge — all changes are documentation-only with no runtime impact.

All findings are P2 style suggestions. The one notable concern (trigger phrase ambiguity in complete-release) is adequately mitigated by the Notes section and description wording; no code paths are affected. The skill path fix in CLAUDE.md is a clean correctness improvement.

.claude/skills/complete-release/SKILL.md — trigger phrase scoping could be tightened to avoid confusion for hotfix authors.

Important Files Changed

Filename Overview
CLAUDE.md Release steps restructured to separate mainline and hotfix paths; skill path reference corrected from .claude/skills/release.md to .claude/skills/release/SKILL.md.
.claude/skills/release/SKILL.md Intro clarified to scope publishing guidance to mainline; PR body template header renamed from "Post-merge" to "Publish"; hotfix note added to the Notes section.
.claude/skills/complete-release/SKILL.md Scope narrowed to mainline in description and intro; Notes section updated with hotfix guidance, but trigger phrases and hardcoded --ref main in Steps 5/6 can mislead hotfix users who invoke "trigger publish workflows".

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Run just release] --> B{Release type?}

    B -->|Mainline| C[Create branch chore/release-vX.Y.Z]
    C --> D[Push → open PR to main]
    D --> E[Review & squash-merge PR]
    E --> F[complete-release skill triggers workflows on main]
    F --> G[CI tags on main, publishes crates/npm]

    B -->|Hotfix| H[Create hotfix/* branch from deployed stable tag]
    H --> I[Run just release on hotfix/* branch]
    I --> J[Push hotfix/* branch]
    J --> K[Manually trigger publish workflows from hotfix/*]
    K --> L[CI tags on hotfix/*, publishes crates/npm]
    L --> M[Merge hotfix/* back to main]
Loading

Reviews (1): Last reviewed commit: "docs(release): align skills and guidance..." | Re-trigger Greptile

greptile-apps[bot]

This comment was marked as resolved.

Remove ambiguous trigger phrase from complete-release skill description so hotfix users are not routed into a main-only publish workflow.
@dev-jodee dev-jodee merged commit 88eb4a7 into main Mar 27, 2026
3 checks passed
@dev-jodee dev-jodee deleted the docs/release-flow-hotfix-guidance branch March 27, 2026 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant