@laitszkin/apollo-toolkit 2.12.2 → 2.12.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -0
- package/CHANGELOG.md +9 -0
- package/README.md +1 -0
- package/commit-and-push/README.md +13 -6
- package/commit-and-push/SKILL.md +21 -29
- package/commit-and-push/agents/openai.yaml +1 -1
- package/package.json +1 -1
- package/submission-readiness-check/SKILL.md +79 -0
- package/submission-readiness-check/agents/openai.yaml +4 -0
- package/version-release/README.md +17 -8
- package/version-release/SKILL.md +27 -25
- package/version-release/agents/openai.yaml +1 -1
package/AGENTS.md
CHANGED
|
@@ -31,6 +31,7 @@ This repository enables users to install and run a curated set of reusable agent
|
|
|
31
31
|
- Users can read, filter, and inspect remote GitHub issues before planning follow-up work.
|
|
32
32
|
- Users can resolve a GitHub issue end-to-end and push the fix directly to a requested branch without opening a PR.
|
|
33
33
|
- Users can run evidence-first application security audits focused on confirmed vulnerabilities.
|
|
34
|
+
- Users can run a shared submission-readiness pass that synchronizes changelog, project docs, `AGENTS.md`, and completed plan archives before commit, push, PR creation, or release.
|
|
34
35
|
- Users can learn new or improved skills from recent Codex conversation history.
|
|
35
36
|
- Users can audit and maintain the skill catalog itself, including dependency classification and shared-skill extraction decisions.
|
|
36
37
|
- Users can summarize mistakes into separate multiple-choice and long-answer error books backed by structured reference files and rendered PDFs.
|
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,15 @@ All notable changes to this repository are documented in this file.
|
|
|
4
4
|
|
|
5
5
|
## [Unreleased]
|
|
6
6
|
|
|
7
|
+
## [v2.12.3] - 2026-03-30
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
- Strengthen `commit-and-push`, `submission-readiness-check`, and `version-release` so submit flows must actually update root `CHANGELOG.md` `Unreleased` before continuing when the pending code-affecting or user-visible change is missing there.
|
|
11
|
+
- Strengthen `commit-and-push` and `version-release` so `review-change-set` remains conditional, but becomes a blocking requirement whenever the change set includes code changes.
|
|
12
|
+
- Strengthen `version-release` prompts and workflow docs to require reading the current version and existing tag/release state first, and to treat the release as incomplete until the matching commit, tag, and GitHub release all exist.
|
|
13
|
+
- Clarify across submit and release workflows that every conditional gate becomes blocking as soon as its triggering scenario is present, including spec archival and other readiness work.
|
|
14
|
+
- Clarify that `discover-edge-cases` and `harden-app-security` are important risk-driven code review gates that also become blocking whenever the change or release surface says they apply.
|
|
15
|
+
|
|
7
16
|
## [v2.12.2] - 2026-03-29
|
|
8
17
|
|
|
9
18
|
### Changed
|
package/README.md
CHANGED
|
@@ -43,6 +43,7 @@ A curated skill catalog for Codex, OpenClaw, and Trae with a managed installer t
|
|
|
43
43
|
- scheduled-runtime-health-check
|
|
44
44
|
- shadow-api-model-research
|
|
45
45
|
- solana-development
|
|
46
|
+
- submission-readiness-check
|
|
46
47
|
- systematic-debug
|
|
47
48
|
- text-to-short-video
|
|
48
49
|
- version-release
|
|
@@ -7,12 +7,13 @@ A Codex skill for commit-and-push workflows without release/version operations.
|
|
|
7
7
|
`commit-and-push` helps agents safely submit local changes by:
|
|
8
8
|
|
|
9
9
|
1. Inspecting git status and staged state.
|
|
10
|
-
2. Running `
|
|
11
|
-
3.
|
|
12
|
-
4.
|
|
13
|
-
5. Running
|
|
14
|
-
6.
|
|
15
|
-
7.
|
|
10
|
+
2. Running `review-change-set` as a blocking gate whenever the change set includes code changes.
|
|
11
|
+
3. Running `archive-specs` during submission to convert completed spec sets and archive them, or when existing project docs need normalization.
|
|
12
|
+
4. Keeping root `CHANGELOG.md` `Unreleased` aligned with the actual pending change set, including removing stale conflicting bullets when needed.
|
|
13
|
+
5. Running `align-project-documents` and `maintain-project-constraints` before commit.
|
|
14
|
+
6. Running additional dependency skills for code-affecting diffs when their coverage is needed.
|
|
15
|
+
7. Committing with a concise Conventional Commit message.
|
|
16
|
+
8. Pushing to the current branch.
|
|
16
17
|
|
|
17
18
|
## Scope
|
|
18
19
|
|
|
@@ -26,4 +27,10 @@ If the repository contains a completed spec set, convert it into the categorized
|
|
|
26
27
|
|
|
27
28
|
Treat root `CHANGELOG.md` `Unreleased` as the source of pending release notes: add or refresh only the bullets that match the current change, keep unrelated pending bullets, and remove older conflicting bullets when the new implementation supersedes them.
|
|
28
29
|
|
|
30
|
+
When the diff includes code changes, `review-change-set` is still a conditional dependency, but that condition is considered met and becomes blocking for the submit flow.
|
|
31
|
+
|
|
32
|
+
Apply the same rule to every other conditional gate: if its scenario is met during classification, it becomes blocking before commit rather than a best-effort follow-up.
|
|
33
|
+
|
|
34
|
+
That includes risk-driven review gates such as `discover-edge-cases` and `harden-app-security` whenever the change surface makes them applicable.
|
|
35
|
+
|
|
29
36
|
For release workflows, use `version-release`.
|
package/commit-and-push/SKILL.md
CHANGED
|
@@ -7,16 +7,16 @@ description: "Guide the agent to submit local changes with commit and push only
|
|
|
7
7
|
|
|
8
8
|
## Dependencies
|
|
9
9
|
|
|
10
|
-
- Required: `
|
|
11
|
-
- Conditional: `review-change-set
|
|
10
|
+
- Required: `submission-readiness-check` before the final commit.
|
|
11
|
+
- Conditional: `review-change-set` is required for code-affecting changes; `discover-edge-cases` and `harden-app-security` are important review gates that remain conditional, but become required whenever the reviewed scope or risk profile warrants them.
|
|
12
12
|
- Optional: none.
|
|
13
|
-
- Fallback: If any required dependency is unavailable,
|
|
13
|
+
- Fallback: If any required dependency is unavailable, stop and report the missing dependency.
|
|
14
14
|
|
|
15
15
|
## Standards
|
|
16
16
|
|
|
17
|
-
- Evidence: Inspect git state and classify the change set before deciding which quality gates apply.
|
|
18
|
-
- Execution: Run the required quality-gate skills when applicable,
|
|
19
|
-
- Quality: Re-run relevant validation for runtime changes,
|
|
17
|
+
- Evidence: Inspect git state and classify the change set before deciding which quality gates apply, then compare the actual pending diff against root `CHANGELOG.md` `Unreleased` before committing.
|
|
18
|
+
- Execution: Run the required quality-gate skills when applicable, and treat every conditional gate whose scenario is met as blocking before submission; hand the repository to `submission-readiness-check` for changelog/docs/plan finalization, preserve staging intent, honor any explicit user-specified target branch, then commit and push without release steps; run dependent git mutations sequentially and verify the remote branch actually contains the new local `HEAD` before reporting success.
|
|
19
|
+
- Quality: Re-run relevant validation for runtime changes, preserve unrelated local work safely when branch switching or post-push local sync is required, and do not bypass blocking readiness findings such as missing/stale `Unreleased` bullets or unsynchronized project docs.
|
|
20
20
|
- Output: Produce a concise Conventional Commit, push it to the intended branch, and report any temporary stash/restore or local branch sync that was required.
|
|
21
21
|
|
|
22
22
|
## Overview
|
|
@@ -43,6 +43,7 @@ Load only when needed:
|
|
|
43
43
|
- `repo-specs-ready-for-conversion`: the relevant `spec.md`, `tasks.md`, and `checklist.md` have been updated to reflect the actual outcome of the work, and any unchecked task/decision checkbox that is clearly not selected, replaced, deferred, or `N/A` (for example, E2E intentionally not created) does not by itself mean the spec set is unfinished.
|
|
44
44
|
- `project-doc-structure-mismatch`: existing `README.md` and project docs do not match the categorized structure required by `archive-specs`.
|
|
45
45
|
- Treat a spec set as still active when it documents remaining implementation gaps, follow-up integration work, undecided design work, or deferred tasks that still belong to the same in-flight change.
|
|
46
|
+
- Any conditional gate whose trigger is confirmed by this classification becomes mandatory before commit, including review, spec archival, docs synchronization, and changelog updates.
|
|
46
47
|
3. Resolve branch target before mutating history
|
|
47
48
|
- Treat an explicit user-specified destination such as `main`, `origin/main`, or another named branch as authoritative over the current branch.
|
|
48
49
|
- If the current branch does not match the requested destination, inspect `git status --short` for unrelated local changes before switching branches.
|
|
@@ -50,33 +51,20 @@ Load only when needed:
|
|
|
50
51
|
- If the fix was committed on the wrong branch, move it to the requested branch with safe history-preserving operations such as `cherry-pick`, `merge --ff-only`, or a clean replay; do not force-push unless the user explicitly asks for it.
|
|
51
52
|
- If the user asks to sync the local target branch after pushing, fast-forward or pull that branch locally and then restore any preserved worktree changes.
|
|
52
53
|
4. Run code-affecting dependency skills (when applicable)
|
|
53
|
-
- Run `review-change-set
|
|
54
|
+
- Run `review-change-set` for every code-affecting change before continuing; treat unresolved review findings as blocking.
|
|
55
|
+
- Run `discover-edge-cases` and `harden-app-security` for the same code-affecting scope when the reviewed risk profile or repository context says their coverage is needed; treat them as blocking review gates, not optional polish, whenever that condition is met.
|
|
54
56
|
- Consolidate and resolve all confirmed findings before continuing.
|
|
55
57
|
- Re-run relevant tests when runtime logic changes.
|
|
56
|
-
5.
|
|
57
|
-
-
|
|
58
|
-
- Let
|
|
59
|
-
-
|
|
60
|
-
-
|
|
61
|
-
-
|
|
62
|
-
|
|
63
|
-
6. Run pre-commit sync dependencies
|
|
64
|
-
- Execute `align-project-documents` after spec conversion and code/doc scans are complete.
|
|
65
|
-
- Execute `maintain-project-constraints` immediately before the commit.
|
|
66
|
-
7. Keep changelog synchronized before commit
|
|
67
|
-
- Treat root `CHANGELOG.md` `Unreleased` as the canonical pending release-notes source.
|
|
68
|
-
- Add or update only the bullets that correspond to the actual current change set.
|
|
69
|
-
- Preserve unaffected `Unreleased` bullets from other pending work.
|
|
70
|
-
- If an older `Unreleased` bullet conflicts with, duplicates, or is superseded by the current implementation, rewrite or remove the stale entry instead of leaving both versions behind.
|
|
71
|
-
- Keep section grouping consistent with the repository changelog format.
|
|
72
|
-
8. Keep docs synchronized when needed
|
|
73
|
-
- Apply the output from `archive-specs` when repository specs were converted or existing project docs were normalized into categorized project docs.
|
|
74
|
-
- Apply the output from `align-project-documents` when behavior or usage changed.
|
|
75
|
-
- Apply the output from `maintain-project-constraints` when agent workflow/rules changed.
|
|
76
|
-
9. Commit
|
|
58
|
+
5. Run shared submission readiness
|
|
59
|
+
- Execute `$submission-readiness-check` after code/doc scans are complete and before the final commit.
|
|
60
|
+
- Let it decide whether completed plan sets should be converted, whether project docs or `AGENTS.md` need synchronization, and whether `CHANGELOG.md` is blocking submission.
|
|
61
|
+
- Do not continue to commit while `submission-readiness-check` reports unresolved readiness blockers.
|
|
62
|
+
- Treat root `CHANGELOG.md` `Unreleased` coverage as mandatory for code-affecting or user-visible changes: if the current work is not reflected there yet, update it before committing instead of merely noting the gap.
|
|
63
|
+
- Re-open the final `CHANGELOG.md` diff after readiness updates and confirm the `Unreleased` bullets describe the same scope as the commit you are about to create.
|
|
64
|
+
6. Commit
|
|
77
65
|
- Preserve user staging intent where possible.
|
|
78
66
|
- Write a concise Conventional Commit message using `references/commit-messages.md`.
|
|
79
|
-
|
|
67
|
+
7. Push
|
|
80
68
|
- Push commit(s) to the intended branch.
|
|
81
69
|
- Do not overlap `git commit`, `git push`, branch switching, or post-push sync operations; wait for each mutation to finish before starting the next one.
|
|
82
70
|
- After pushing, verify the remote branch tip matches the local `HEAD`, for example by comparing `git rev-parse HEAD` with the target branch hash from `git rev-parse @{u}` or `git ls-remote --heads <remote> <branch>`.
|
|
@@ -86,6 +74,10 @@ Load only when needed:
|
|
|
86
74
|
## Notes
|
|
87
75
|
|
|
88
76
|
- Never run version bump, tag creation, or changelog release steps in this skill.
|
|
77
|
+
- Treat every scenario-matched gate as blocking before commit, not as an optional reminder to maybe do later.
|
|
78
|
+
- Never skip `review-change-set` for code-affecting changes, and do not continue past review while confirmed findings remain unresolved.
|
|
79
|
+
- Never downgrade `discover-edge-cases` or `harden-app-security` to optional follow-up when the change risk says they apply.
|
|
80
|
+
- Never claim the repository is ready to commit while root `CHANGELOG.md` `Unreleased` is missing the current change or still describes superseded work.
|
|
89
81
|
- If release/version/tag work is requested, use `version-release` instead.
|
|
90
82
|
- If a new branch is required, follow `references/branch-naming.md`.
|
|
91
83
|
- A pushed implementation can still leave an active spec set behind; commit completion and spec archival are separate decisions.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Commit and Push"
|
|
3
3
|
short_description: "Submit local changes with commit and push only"
|
|
4
|
-
default_prompt: "Use $commit-and-push to inspect the current git state
|
|
4
|
+
default_prompt: "Use $commit-and-push to inspect the current git state and classify the diff. Treat every conditional gate whose scenario is met as blocking before any commit: if the change set includes code changes, run $review-change-set; if the reviewed risk profile says edge-case or security review is needed, run $discover-edge-cases and $harden-app-security as blocking gates too; if completed specs should be converted or docs need normalization, ensure $archive-specs runs through $submission-readiness-check; if changelog synchronization is needed, complete it before continuing. Then run any additional required code-quality skills, hand the repository to $submission-readiness-check so it can synchronize completed plan archives, project docs, AGENTS.md, and CHANGELOG.md before any commit, confirm root CHANGELOG.md Unreleased reflects the actual pending change set, preserve user staging intent, create a concise Conventional Commit, and push to the intended branch without any versioning or release steps."
|
package/package.json
CHANGED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: submission-readiness-check
|
|
3
|
+
description: Prepare a repository for safe submission by synchronizing `CHANGELOG.md`, project docs, `AGENTS.md`, and completed planning artifacts before commit, push, PR creation, or release. Use when a workflow is about to submit changes and must avoid missing finalization steps such as stale `Unreleased` notes, unarchived completed spec sets, or unsynchronized agent constraints.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Submission Readiness Check
|
|
7
|
+
|
|
8
|
+
## Dependencies
|
|
9
|
+
|
|
10
|
+
- Required: `align-project-documents` and `maintain-project-constraints` before any git submission step.
|
|
11
|
+
- Conditional: `archive-specs` when completed `spec.md` / `tasks.md` / `checklist.md` sets should be converted into categorized project docs and archived, or when existing project docs need normalization into the standard structure.
|
|
12
|
+
- Optional: none.
|
|
13
|
+
- Fallback: If a required dependency is unavailable, or if spec conversion is required but `archive-specs` is unavailable, stop and report the missing dependency instead of submitting partially synchronized changes.
|
|
14
|
+
|
|
15
|
+
## Standards
|
|
16
|
+
|
|
17
|
+
- Evidence: Inspect the actual git diff, staged set, planning artifacts, `CHANGELOG.md`, and current project docs before declaring the repository ready to submit.
|
|
18
|
+
- Execution: Decide whether the target flow is commit/push, PR, or release; normalize completed spec sets when appropriate; synchronize project docs plus `AGENTS.md`; then enforce changelog readiness before any commit, tag, push, PR creation, or release publishing step.
|
|
19
|
+
- Quality: Treat missing or stale changelog entries as blocking issues for submit workflows, preserve unrelated pending `Unreleased` bullets, do not archive active plan sets that still track unfinished scope, and do not hand back a ready verdict until every conditional gate whose scenario is met has actually been completed.
|
|
20
|
+
- Output: Return a ready-to-submit verdict with the synchronized files and any blocking items that must be fixed before the owning submit workflow continues.
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
Use this skill as the shared finalization pass before repository submission workflows. It exists to prevent repeated omissions such as forgetting `CHANGELOG.md`, shipping stale project docs, or leaving completed plan sets unarchived.
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
### 1) Inventory the real submission surface
|
|
29
|
+
|
|
30
|
+
- Read `git status -sb`, `git diff --stat`, and `git diff --cached --stat`.
|
|
31
|
+
- Check whether the repository has root `CHANGELOG.md`, top-level `AGENTS.md`, and categorized project docs already in use.
|
|
32
|
+
- Inventory planning artifacts across the repository, not only staged files, so completed plan sets are not missed.
|
|
33
|
+
- Classify the intended downstream flow:
|
|
34
|
+
- `commit-push`
|
|
35
|
+
- `pull-request`
|
|
36
|
+
- `release`
|
|
37
|
+
|
|
38
|
+
### 2) Decide whether planning artifacts should be converted
|
|
39
|
+
|
|
40
|
+
- Treat live `spec.md`, `tasks.md`, and `checklist.md` sets semantically instead of mechanically.
|
|
41
|
+
- Run `$archive-specs` when the relevant plan set reflects the delivered outcome, or when project docs still need normalization into the standard categorized structure.
|
|
42
|
+
- Keep a plan set live when it still documents unfinished implementation, unresolved design work, or same-scope follow-up that is intentionally not shipping yet.
|
|
43
|
+
- If the archive scenario is met, treat `$archive-specs` as blocking before returning a ready-to-submit verdict.
|
|
44
|
+
|
|
45
|
+
### 3) Synchronize project docs and constraints
|
|
46
|
+
|
|
47
|
+
- Run `$align-project-documents` after spec conversion or doc inspection is complete.
|
|
48
|
+
- Run `$maintain-project-constraints` immediately before the owning submission workflow mutates git history.
|
|
49
|
+
- Apply the resulting doc and `AGENTS.md` updates when behavior, operator workflow, or standing project rules changed.
|
|
50
|
+
|
|
51
|
+
### 4) Enforce changelog readiness
|
|
52
|
+
|
|
53
|
+
- Treat root `CHANGELOG.md` as the canonical user-facing submission summary when it exists.
|
|
54
|
+
- For `commit-push` and `pull-request` flows:
|
|
55
|
+
- Keep `Unreleased` aligned with the actual pending change set.
|
|
56
|
+
- Add or update only the bullets that correspond to the current work.
|
|
57
|
+
- Preserve unrelated pending bullets from other unshipped work.
|
|
58
|
+
- Remove or rewrite stale bullets when the current implementation supersedes them.
|
|
59
|
+
- If `Unreleased` is missing the current code-affecting or user-visible change, edit `CHANGELOG.md` now instead of returning a warning for another workflow to maybe fix later.
|
|
60
|
+
- For `release` flows:
|
|
61
|
+
- Require a non-empty `Unreleased` section before the release continues.
|
|
62
|
+
- Ensure the release workflow will cut notes directly from curated changelog content instead of reconstructing them from `git diff`.
|
|
63
|
+
- Confirm the `Unreleased` bullets are release-ready before handing control back: they must describe the exact release scope that will be versioned and tagged next.
|
|
64
|
+
- If code-affecting or user-visible changes are about to ship and `CHANGELOG.md` does not reflect them, stop and fix the changelog before continuing.
|
|
65
|
+
|
|
66
|
+
### 5) Hand back a submission verdict
|
|
67
|
+
|
|
68
|
+
- Confirm which files were synchronized:
|
|
69
|
+
- project docs
|
|
70
|
+
- `AGENTS.md`
|
|
71
|
+
- `CHANGELOG.md`
|
|
72
|
+
- archived plan sets
|
|
73
|
+
- If anything remains unsynchronized, report it as a blocking item rather than letting the submit workflow continue optimistically.
|
|
74
|
+
|
|
75
|
+
## Notes
|
|
76
|
+
|
|
77
|
+
- Do not create commits, tags, pushes, PRs, or releases inside this skill.
|
|
78
|
+
- Treat scenario-matched conditional gates such as spec archival, docs synchronization, and changelog updates as blocking readiness work, not optional follow-up.
|
|
79
|
+
- Use this skill as a shared preflight for submit workflows rather than duplicating the same finalization checklist in multiple skills.
|
|
@@ -7,14 +7,15 @@ A Codex skill for explicit release workflows: code/documentation alignment, vers
|
|
|
7
7
|
`version-release` helps agents perform release work in a repeatable flow:
|
|
8
8
|
|
|
9
9
|
1. Inspect the current repository state and the curated `CHANGELOG.md` `Unreleased` content.
|
|
10
|
-
2. Run
|
|
11
|
-
3. Run
|
|
12
|
-
4.
|
|
13
|
-
5.
|
|
14
|
-
6.
|
|
15
|
-
7.
|
|
16
|
-
8.
|
|
17
|
-
9.
|
|
10
|
+
2. Run `review-change-set` as a blocking gate whenever the release includes code changes.
|
|
11
|
+
3. Run additional quality gates for code-affecting changes when their coverage is needed.
|
|
12
|
+
4. Run `archive-specs` before finalizing the release to convert completed spec sets and archive them, or when existing project docs need normalization.
|
|
13
|
+
5. Align project code and categorized project docs.
|
|
14
|
+
6. Resolve version and tag details by reading the current version and existing tag/release state first.
|
|
15
|
+
7. Update version files and cut the release directly from `CHANGELOG.md` `Unreleased`.
|
|
16
|
+
8. Commit release metadata.
|
|
17
|
+
9. Create and push the release tag.
|
|
18
|
+
10. Publish the matching GitHub release and verify any release-triggered automation.
|
|
18
19
|
|
|
19
20
|
## Scope
|
|
20
21
|
|
|
@@ -29,4 +30,12 @@ If the repository contains a completed spec set, convert it into the categorized
|
|
|
29
30
|
|
|
30
31
|
Do not rebuild release notes from `git diff`. Publish from the already curated root `CHANGELOG.md` `Unreleased` content by moving it into the target version entry and clearing `Unreleased` afterward.
|
|
31
32
|
|
|
33
|
+
When the release includes code changes, `review-change-set` is still a conditional dependency, but that condition is considered met and becomes blocking before any version bump, tag, or release publication.
|
|
34
|
+
|
|
35
|
+
Apply the same rule to every other conditional gate: if its scenario is met during release classification, it becomes blocking before version bumping, tagging, or release publication.
|
|
36
|
+
|
|
37
|
+
That includes risk-driven review gates such as `discover-edge-cases` and `harden-app-security` whenever the release surface makes them applicable.
|
|
38
|
+
|
|
39
|
+
Do not report release completion after only bumping versions or pushing a commit: the matching tag and GitHub release are part of done criteria unless the user explicitly says to skip publication.
|
|
40
|
+
|
|
32
41
|
If the user only wants commit + push, use `commit-and-push`.
|
package/version-release/SKILL.md
CHANGED
|
@@ -7,16 +7,16 @@ description: "Guide the agent to prepare and publish a versioned release (versio
|
|
|
7
7
|
|
|
8
8
|
## Dependencies
|
|
9
9
|
|
|
10
|
-
- Required:
|
|
11
|
-
- Conditional: `review-change-set
|
|
10
|
+
- Required: `submission-readiness-check` before version metadata edits, tagging, or release publication.
|
|
11
|
+
- Conditional: `review-change-set` is required for code-affecting releases before metadata edits and the final commit; `discover-edge-cases` and `harden-app-security` are important review gates that remain conditional, but become required whenever the reviewed scope or risk profile warrants them.
|
|
12
12
|
- Optional: none.
|
|
13
|
-
- Fallback: If a required release dependency is unavailable
|
|
13
|
+
- Fallback: If a required release dependency is unavailable, stop and report the missing dependency.
|
|
14
14
|
|
|
15
15
|
## Standards
|
|
16
16
|
|
|
17
|
-
- Evidence: Inspect the active change set, current version files, and root `CHANGELOG.md` `Unreleased` content before touching version files, tags, or release metadata.
|
|
18
|
-
- Execution: Use this workflow only for explicit release intent, run the required quality gates when applicable,
|
|
19
|
-
- Quality: Never guess versions, align user-facing docs with actual code,
|
|
17
|
+
- Evidence: Inspect the active change set, current version files, existing tag format, existing remote tags/releases, and root `CHANGELOG.md` `Unreleased` content before touching version files, tags, or release metadata.
|
|
18
|
+
- Execution: Use this workflow only for explicit release intent, run the required quality gates when applicable, and treat every conditional gate whose scenario is met as blocking before versioning or publication; hand the repository to `submission-readiness-check` before versioning work, then cut the release directly from `CHANGELOG.md` `Unreleased`, update versions and docs, commit, tag, push, and publish the GitHub release; run git mutations sequentially and verify both the branch tip and release tag exist remotely before publishing the GitHub release.
|
|
19
|
+
- Quality: Never guess versions, align user-facing docs with actual code, do not bypass readiness blockers from `submission-readiness-check`, do not reconstruct release notes from `git diff` when curated changelog content already exists, and do not report release success until the commit, tag, and GitHub release all exist for the same version.
|
|
20
20
|
- Output: Produce a versioned release commit and tag, publish a matching GitHub release, and keep changelog plus relevant repository documentation synchronized.
|
|
21
21
|
|
|
22
22
|
## Overview
|
|
@@ -54,31 +54,27 @@ Load only when needed:
|
|
|
54
54
|
- `repo-specs-present`: the repository contains live project planning artifacts such as `spec.md`, `tasks.md`, `checklist.md`, or plan directories; exclude reference examples, templates, and archived samples.
|
|
55
55
|
- `repo-specs-ready-for-conversion`: the relevant `spec.md`, `tasks.md`, and `checklist.md` reflect the actual delivered outcome, and any unchecked task/decision checkbox that is clearly not selected, replaced, deferred, or `N/A` (for example, E2E intentionally not created) does not by itself mean the spec set is unfinished.
|
|
56
56
|
- `project-doc-structure-mismatch`: existing `README.md` and project docs do not match the categorized structure required by `archive-specs`.
|
|
57
|
-
- For code-affecting changes, run `review-change-set
|
|
57
|
+
- For code-affecting changes, run `review-change-set` for the same release scope before continuing; treat unresolved review findings as blocking.
|
|
58
|
+
- Run `discover-edge-cases` and `harden-app-security` for the same release scope when the reviewed risk profile or repository context says their coverage is needed; treat them as blocking review gates, not optional polish, whenever that condition is met.
|
|
59
|
+
- Any conditional gate whose trigger is confirmed by this classification becomes mandatory before version bumping, tagging, or release publication, including review, spec archival, docs synchronization, and changelog readiness.
|
|
58
60
|
- Consolidate all confirmed findings before continuing.
|
|
59
61
|
- Resolve all confirmed findings before changing version files, tags, or release metadata.
|
|
60
|
-
4.
|
|
61
|
-
-
|
|
62
|
-
- Let
|
|
63
|
-
-
|
|
64
|
-
|
|
65
|
-
- If the docs still show unresolved implementation scope that is neither completed, intentionally deferred, nor explicitly `N/A`, do not convert them yet; report that the spec files remain active and should not be deleted.
|
|
66
|
-
5. Align code and project docs
|
|
67
|
-
- Compare the pending release intent plus current repository behavior with user-facing docs and operational docs to ensure they match actual code behavior.
|
|
68
|
-
- Required alignment targets include project docs such as `README.md`, usage/setup docs, API docs, deployment/runbook docs, and release notes sources when present.
|
|
69
|
-
- After `archive-specs` runs, treat the categorized outputs as the canonical project-doc structure.
|
|
70
|
-
- If existing project docs are present but still use a mixed or non-standard layout, normalize them into the same categorized structure before version bumping or tagging.
|
|
71
|
-
- If mismatches are found, update the relevant project docs before version bumping/tagging.
|
|
72
|
-
6. Decide version and tag format
|
|
62
|
+
4. Run shared submission readiness
|
|
63
|
+
- Execute `$submission-readiness-check` before version file edits, tags, or release publication.
|
|
64
|
+
- Let it decide whether completed plan sets should be archived, whether project docs or `AGENTS.md` need synchronization, and whether `CHANGELOG.md` `Unreleased` is ready to be cut into a versioned release entry.
|
|
65
|
+
- Do not continue while `submission-readiness-check` reports unresolved blockers.
|
|
66
|
+
5. Decide version and tag format
|
|
73
67
|
- Read existing version files (for example `project.toml`, `package.json`, or repo-specific version files).
|
|
74
68
|
- Infer existing tag format (`vX.Y.Z` or `X.Y.Z`) from repository tags.
|
|
69
|
+
- Inspect existing local and remote tags plus any existing GitHub Release for the target version before creating new release metadata, so duplicate or conflicting releases are caught early.
|
|
75
70
|
- If the user provides the target version, use it directly.
|
|
76
71
|
- If it is missing, ask the user for the target version or semver bump type.
|
|
77
72
|
- Provide recommendations only when explicitly requested.
|
|
78
|
-
|
|
73
|
+
- Do not continue until you can state the current version, the intended next version, and the exact tag name that will be created.
|
|
74
|
+
6. Update version files
|
|
79
75
|
- Update every detected version file consistently.
|
|
80
76
|
- Preserve file formatting; change only version values.
|
|
81
|
-
|
|
77
|
+
7. Update release docs
|
|
82
78
|
- Treat root `CHANGELOG.md` `Unreleased` as the canonical pending release content.
|
|
83
79
|
- If `Unreleased` is empty, stop and report that there are no curated release notes to publish yet.
|
|
84
80
|
- Create the new version entry by moving the current `Unreleased` sections under the selected version heading and release date.
|
|
@@ -86,23 +82,29 @@ Load only when needed:
|
|
|
86
82
|
- Remove duplicate section headers or bullets only when the move would otherwise create repeated content.
|
|
87
83
|
- Update `README.md` only when behavior or usage changed.
|
|
88
84
|
- Update `AGENTS.md` only when agent workflow/rules changed.
|
|
89
|
-
|
|
85
|
+
8. Commit and tag
|
|
90
86
|
- Create a release-oriented commit message (for example `chore(release): publish 2.12.1`) when applicable.
|
|
91
87
|
- Create the version tag locally after commit.
|
|
92
|
-
|
|
88
|
+
- Re-read the version files after editing and before tagging to confirm they all match the intended release version.
|
|
89
|
+
9. Push
|
|
93
90
|
- Push commit(s) and the release tag to the current branch before publishing the GitHub release when the hosting platform requires the tag to exist remotely.
|
|
94
91
|
- Do not overlap `git commit`, `git tag`, `git push`, or release-publish steps; wait for each mutation to finish before starting the next one.
|
|
95
92
|
- After pushing, verify the remote branch tip matches local `HEAD`, and verify the release tag exists remotely via `git ls-remote --tags <remote> <tag>`.
|
|
96
93
|
- If any git step finishes ambiguously or the remote hashes do not match local state, rerun the missing step sequentially and re-check before publishing the GitHub release.
|
|
97
|
-
|
|
94
|
+
10. Publish the GitHub release
|
|
98
95
|
- Create a non-draft GitHub release that matches the pushed version tag.
|
|
99
96
|
- Use the release notes from the new `CHANGELOG.md` entry unless the repository has a stronger established release-note source.
|
|
100
97
|
- If the repository has publish automation triggered by `release.published`, ensure the GitHub release is actually published rather than left as a draft.
|
|
101
98
|
- Prefer `gh release create <tag>` or the repository's existing release tool when available.
|
|
102
99
|
- Confirm the GitHub release URL and any triggered publish workflow status in the final report.
|
|
100
|
+
- Never stop after the release commit or tag alone; creating the matching GitHub release is part of done criteria unless the user explicitly says to skip release publication.
|
|
103
101
|
|
|
104
102
|
## Notes
|
|
105
103
|
|
|
106
104
|
- Never guess versions; always read from files and user intent.
|
|
105
|
+
- Treat every scenario-matched gate as blocking before versioning or release publication, not as an optional reminder to maybe do later.
|
|
106
|
+
- Never skip `review-change-set` for code-affecting releases, and do not continue to versioning work while confirmed review findings remain unresolved.
|
|
107
|
+
- Never downgrade `discover-edge-cases` or `harden-app-security` to optional follow-up when the release risk says they apply.
|
|
108
|
+
- Never claim a release is complete without checking the actual release version, creating the matching tag, and publishing the matching GitHub release.
|
|
107
109
|
- If tests are required by repository conventions, run them before commit.
|
|
108
110
|
- If a new branch is required, follow `references/branch-naming.md`.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Version Release"
|
|
3
3
|
short_description: "Prepare a versioned release with bump, changelog, tag, GitHub release, and push"
|
|
4
|
-
default_prompt: "Use $version-release only for explicit release/version/tag requests: inspect the current repository state and root CHANGELOG.md Unreleased content,
|
|
4
|
+
default_prompt: "Use $version-release only for explicit release/version/tag requests: inspect the current repository state, read the current version plus existing tag/release state, and inspect root CHANGELOG.md Unreleased content. Treat every conditional gate whose scenario is met as blocking before any version bump, tag, or release step: if the release includes code changes, run $review-change-set; if the reviewed risk profile says edge-case or security review is needed, run $discover-edge-cases and $harden-app-security as blocking gates too; if completed specs should be converted or docs need normalization, ensure $archive-specs runs through $submission-readiness-check; if changelog synchronization is needed, complete it before continuing. Then run any additional required code-quality skills, hand the repository to $submission-readiness-check so completed plan archives, project docs, AGENTS.md, and changelog readiness are settled before any version bump or tag, confirm CHANGELOG.md Unreleased is release-ready, update version files, cut the release directly from CHANGELOG.md Unreleased, create the release commit and matching tag, push commits and tags, and publish the matching GitHub release before reporting success."
|