54e6da3126
* fix(#2767): pass paths via --files to gsd-sdk query commit + lint guard Workflows, agents, commands, and references passed file paths positionally to `gsd-sdk query commit`, which silently appended them to the commit subject and triggered the `.planning/` wholesale-stage fallback in sdk/src/query/commit.ts:136. Regression of #733/#798. Inserted `--files` before the path list at every site (81 invocations across 50 files). Added tests/bug-2767-gsd-sdk-commit-files-flag.test.cjs as a permanent lint that scans every shipped .md file and asserts each `gsd-sdk query commit[-to-subrepo]` invocation either uses `--files` or carries no path arguments. Closes #2767 * test(#2767): replace source-grep with behavioral SDK test The original test walked every shipped .md file and regex-tokenized `gsd-sdk query commit` invocations to assert `--files` was present. CONTRIBUTING.md prohibits this source-grep pattern. Rewrite as behavioral SDK tests against `sdk/dist/cli.js` over a real tmp git project (createTempGitProject helper). Cover both the well-formed (`--files <paths>`) form — clean subject, exactly-staged files, .planning/ left untouched — and the buggy positional form, asserting the documented misbehavior (paths leak into subject + the `.planning/` wholesale-stage fallback at commit.ts:136). Also asserts `commit-to-subrepo` rejects when `--files` is omitted (commit.ts:258). The doc-lint is retained as a supplementary defense-in-depth guard since agent-prompt markdown invocations cannot be exercised end-to-end — but it is no longer the primary contract. * docs(#2767): correct contradictory --files guidance in zh-CN/en docs + fix test docstring
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Git Planning Commit
|
|
|
|
Commit planning artifacts via `gsd-sdk query commit`, which checks `commit_docs` config and gitignore status (same behavior as legacy `gsd-tools.cjs commit`).
|
|
|
|
## Commit via CLI
|
|
|
|
Pass the message first, then file paths via `--files`. Both `commit` and `commit-to-subrepo` use `--files` to declare the paths to commit.
|
|
|
|
Always use this for `.planning/` files — it handles `commit_docs` and gitignore checks automatically:
|
|
|
|
```bash
|
|
gsd-sdk query commit "docs({scope}): {description}" --files .planning/STATE.md .planning/ROADMAP.md
|
|
```
|
|
|
|
The CLI will return `skipped` (with reason) if `commit_docs` is `false` or `.planning/` is gitignored. No manual conditional checks needed.
|
|
|
|
## Amend previous commit
|
|
|
|
To fold `.planning/` file changes into the previous commit:
|
|
|
|
```bash
|
|
gsd-sdk query commit "" --files .planning/codebase/*.md --amend
|
|
```
|
|
|
|
## Commit Message Patterns
|
|
|
|
| Command | Scope | Example |
|
|
|---------|-------|---------|
|
|
| plan-phase | phase | `docs(phase-03): create authentication plans` |
|
|
| execute-phase | phase | `docs(phase-03): complete authentication phase` |
|
|
| new-milestone | milestone | `docs: start milestone v1.1` |
|
|
| remove-phase | chore | `chore: remove phase 17 (dashboard)` |
|
|
| insert-phase | phase | `docs: insert phase 16.1 (critical fix)` |
|
|
| add-phase | phase | `docs: add phase 07 (settings page)` |
|
|
|
|
## When to Skip
|
|
|
|
- `commit_docs: false` in config
|
|
- `.planning/` is gitignored
|
|
- No changes to commit (check with `git status --porcelain .planning/`)
|