Skip to content

Commit c0dd897

Browse files
authored
Merge pull request #106 from nold-ai/dev
release: merge dev to main (bundle resources + OpenSpec updates)
2 parents 61cbdd9 + 32a43f5 commit c0dd897

77 files changed

Lines changed: 3877 additions & 206 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/authoring/publishing-modules.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ Recommended layout:
2828
commands.py # or app.py, etc.
2929
```
3030

31+
Official bundles may also ship **bundle-owned resources** next to the manifest (included in the signed module payload), for example:
32+
33+
- `resources/prompts/` — workflow prompt templates and `resources/prompts/shared/` companion files referenced by relative paths from those prompts
34+
- `resources/templates/backlog/field_mappings/` — backlog field-mapping seed YAML copied by init/install flows (mirrored under `src/<python_package>/resources/...` when the runtime must resolve them via `find_package_resources_path`)
35+
36+
Any change under `resources/` is part of the module payload: bump `version` in `module-package.yaml` and re-sign integrity metadata the same way as for code changes.
37+
3138
Exclude from the package: `.git`, `__pycache__`, `tests`, `.pytest_cache`, `*.pyc`, `*.pyo`.
3239

3340
## Script: publish-module.py

openspec/CHANGE_ORDER.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@
3030

3131
## Pending
3232

33+
### Packaging and bundle payloads
34+
35+
| Module | Order | Change folder | GitHub # | Blocked by |
36+
|--------|-------|---------------|----------|------------|
37+
| packaging | 01 | packaging-01-bundle-resource-payloads | [#101](https://github.com/nold-ai/specfact-cli-modules/issues/101) | specfact-cli/packaging-02-cross-platform-runtime-and-module-resources defines the consuming installed-resource contract; specfact-cli/init-ide-prompt-source-selection ([#382](https://github.com/nold-ai/specfact-cli/issues/382)) owns runtime selection/export orchestration |
38+
3339
### Code review bundle expansion
3440

3541
| Module | Order | Change folder | GitHub # | Blocked by |

openspec/changes/docs-08-bundle-overview-pages/proposal.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Users of specific bundles cannot quickly find all available commands, understand
77
## What Changes
88

99
- Write 6 new bundle overview pages, one per official bundle: backlog, project, codebase, spec, govern, code-review
10-
- Each overview page contains: bundle purpose, prerequisites, full command listing with brief descriptions, quick example for each major command group, and links to deep-dive guides
10+
- Each overview page contains: bundle purpose, prerequisites, bundle-owned resource/setup notes where relevant, full command listing with brief descriptions, quick example for each major command group, and links to deep-dive guides
1111
- All command examples validated against actual `--help` output
1212

1313
## Capabilities
@@ -20,6 +20,7 @@ Users of specific bundles cannot quickly find all available commands, understand
2020

2121
- New files: `docs/bundles/backlog/overview.md`, `docs/bundles/project/overview.md`, `docs/bundles/codebase/overview.md`, `docs/bundles/spec/overview.md`, `docs/bundles/govern/overview.md`, `docs/bundles/code-review/overview.md`
2222
- Depends on: `docs-06-modules-site-ia-restructure` (bundles/ directory structure must exist)
23+
- Aligns with: `packaging-01-bundle-resource-payloads` for bundle-owned prompts/templates and `specfact init ide` resource ownership
2324
- User-facing: each bundle has a clear entry point for discovering all available commands
2425

2526
## Source Tracking
Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
# Capability: bundle-overview-pages
2-
3-
Each official bundle has a single overview page listing all commands, prerequisites, and quick examples.
4-
5-
## Scenarios
6-
7-
### Scenario: Overview page lists all bundle commands
8-
9-
Given a bundle overview page (e.g., bundles/backlog/overview.md)
10-
When a user reads the page
11-
Then every registered command and subcommand for that bundle is listed
12-
And each command has a brief description
13-
14-
### Scenario: Overview page includes quick examples
15-
16-
Given a bundle overview page
17-
When a user reads the page
18-
Then at least one practical example is shown for each major command group
19-
20-
### Scenario: Command examples match actual CLI
21-
22-
Given a command example in an overview page
23-
When compared against the actual `specfact <command> --help` output
24-
Then the command name, arguments, and key options match
1+
## ADDED Requirements
2+
3+
### Requirement: Bundle overview pages SHALL provide complete bundle entry points
4+
Each official bundle SHALL have a single overview page that lists its commands, prerequisites, examples, and relevant bundle-owned resource setup guidance.
5+
6+
#### Scenario: Overview page lists all bundle commands
7+
- **GIVEN** a bundle overview page such as `bundles/backlog/overview.md`
8+
- **WHEN** a user reads the page
9+
- **THEN** every registered command and subcommand for that bundle is listed
10+
- **AND** each command has a brief description
11+
12+
#### Scenario: Overview page includes quick examples
13+
- **GIVEN** a bundle overview page
14+
- **WHEN** a user reads the page
15+
- **THEN** at least one practical example is shown for each major command group
16+
17+
#### Scenario: Overview page explains bundle-owned resource setup when relevant
18+
- **GIVEN** a bundle overview page for a bundle that ships prompts or workspace templates
19+
- **WHEN** a user reads the page
20+
- **THEN** the page explains which resources are bundled with that package
21+
- **AND** it points to the supported setup flow such as `specfact init ide` or bundle-specific template/bootstrap commands
22+
23+
#### Scenario: Command examples match actual CLI
24+
- **GIVEN** a command example in an overview page
25+
- **WHEN** compared against the actual `specfact <command> --help` output
26+
- **THEN** the command name, arguments, and key options match

openspec/changes/docs-08-bundle-overview-pages/tasks.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55

66
## 2. Write Overview Pages
77

8-
- [ ] 2.1 Write `bundles/backlog/overview.md`: ceremony, daily, refine, add, analyze-deps, sync, diff, promote, verify-readiness, delta, policy, init-config, map-fields
9-
- [ ] 2.2 Write `bundles/project/overview.md`: link-backlog, health-check, snapshot, regenerate, export-roadmap, version, sync bridge, devops-flow, plan init, import, migrate, add-feature, add-story
10-
- [ ] 2.3 Write `bundles/codebase/overview.md`: import, analyze contracts, drift detect, validate sidecar, repro
11-
- [ ] 2.4 Write `bundles/spec/overview.md`: contract (init/validate/coverage/serve/verify/test), generate, sdd
12-
- [ ] 2.5 Write `bundles/govern/overview.md`: enforce (stage/sdd), patch
8+
- [ ] 2.1 Write `bundles/backlog/overview.md`: ceremony, daily, refine, add, analyze-deps, sync, diff, promote, verify-readiness, delta, policy, init-config, map-fields, plus bundled template/bootstrap notes
9+
- [ ] 2.2 Write `bundles/project/overview.md`: link-backlog, health-check, snapshot, regenerate, export-roadmap, version, sync bridge, devops-flow, plan init, import, migrate, add-feature, add-story, plan review, plan harden, plan compare, plus bundled prompt notes
10+
- [ ] 2.3 Write `bundles/codebase/overview.md`: import, analyze contracts, drift detect, validate sidecar, repro, plus bundled prompt notes
11+
- [ ] 2.4 Write `bundles/spec/overview.md`: contract (init/validate/coverage/serve/verify/test), generate, sdd, plus bundled prompt notes where relevant
12+
- [ ] 2.5 Write `bundles/govern/overview.md`: enforce (stage/sdd), patch, plus bundled prompt notes
1313
- [ ] 2.6 Write `bundles/code-review/overview.md`: run, ledger, rules
1414

1515
## 3. Verification
1616

1717
- [ ] 3.1 Validate every command example against `--help` output
18-
- [ ] 3.2 Verify all internal links resolve
19-
- [ ] 3.3 Run `bundle exec jekyll build` with zero warnings
18+
- [ ] 3.2 Verify bundle overview pages do not describe migrated prompts/templates as core-owned assets
19+
- [ ] 3.3 Verify all internal links resolve
20+
- [ ] 3.4 Run `bundle exec jekyll build` with zero warnings

openspec/changes/docs-09-missing-command-docs/proposal.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The spec, govern, code-review, and codebase bundles have minimal or no documenta
77
## What Changes
88

99
- Write 11 new command reference pages covering all undocumented commands across 4 bundles
10-
- Each page contains: command purpose, prerequisites, full option reference, practical examples, common patterns, and links to related commands
10+
- Each page contains: command purpose, prerequisites, bundle-owned resource/setup notes where relevant, full option reference, practical examples, common patterns, and links to related commands
1111
- All examples validated against actual implementations
1212

1313
## Capabilities
@@ -23,6 +23,7 @@ The spec, govern, code-review, and codebase bundles have minimal or no documenta
2323

2424
- New files (11): `bundles/spec/validate.md`, `bundles/spec/generate-tests.md`, `bundles/spec/mock.md`, `bundles/govern/enforce.md`, `bundles/govern/patch.md`, `bundles/code-review/run.md`, `bundles/code-review/ledger.md`, `bundles/code-review/rules.md`, `bundles/codebase/analyze.md`, `bundles/codebase/drift.md`, `bundles/codebase/repro.md`
2525
- Depends on: `docs-06-modules-site-ia-restructure` (bundles/ directory structure must exist)
26+
- Aligns with: `packaging-01-bundle-resource-payloads` so docs describe migrated bundle-owned prompts/templates consistently
2627

2728
## Source Tracking
2829

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
1-
# Capability: missing-command-docs
2-
3-
Reference documentation for all previously undocumented commands across spec, govern, code-review, and codebase bundles.
4-
5-
## Scenarios
6-
7-
### Scenario: Each command page documents full option reference
8-
9-
Given a command reference page (e.g., bundles/govern/enforce.md)
10-
When a user reads the page
11-
Then every option and argument from the command's --help output is documented
12-
And practical examples demonstrate common usage patterns
13-
14-
### Scenario: Spec bundle has complete documentation
15-
16-
Given the spec bundle overview links to deep-dive pages
17-
When a user follows links to validate, generate-tests, and mock
18-
Then each page exists and contains command reference, examples, and related commands
19-
20-
### Scenario: Govern bundle has complete documentation
21-
22-
Given the govern bundle overview links to deep-dive pages
23-
When a user follows links to enforce and patch
24-
Then each page exists and contains command reference, examples, and related commands
25-
26-
### Scenario: Code review bundle has complete documentation
27-
28-
Given the code-review bundle overview links to deep-dive pages
29-
When a user follows links to run, ledger, and rules
30-
Then each page exists and contains command reference, examples, and related commands
1+
## ADDED Requirements
2+
3+
### Requirement: Missing command reference pages SHALL document the implemented command surface
4+
Previously undocumented command pages SHALL describe the current option surface, examples, and relevant bundle-owned resource guidance for their commands.
5+
6+
#### Scenario: Each command page documents full option reference
7+
- **GIVEN** a command reference page such as `bundles/govern/enforce.md`
8+
- **WHEN** a user reads the page
9+
- **THEN** every option and argument from the command's `--help` output is documented
10+
- **AND** practical examples demonstrate common usage patterns
11+
12+
#### Scenario: Command pages explain bundle-owned resources where they affect usage
13+
- **GIVEN** a command reference page for a command that depends on migrated bundle-owned prompts or templates
14+
- **WHEN** a user reads the page
15+
- **THEN** the page explains the relevant setup or bootstrap path
16+
- **AND** it does not direct users to legacy core-owned resource locations
17+
18+
#### Scenario: Spec bundle has complete documentation
19+
- **GIVEN** the spec bundle overview links to deep-dive pages
20+
- **WHEN** a user follows links to validate, generate-tests, and mock
21+
- **THEN** each page exists and contains command reference, examples, and related commands
22+
23+
#### Scenario: Govern bundle has complete documentation
24+
- **GIVEN** the govern bundle overview links to deep-dive pages
25+
- **WHEN** a user follows links to enforce and patch
26+
- **THEN** each page exists and contains command reference, examples, and related commands
27+
28+
#### Scenario: Code review bundle has complete documentation
29+
- **GIVEN** the code-review bundle overview links to deep-dive pages
30+
- **WHEN** a user follows links to run, ledger, and rules
31+
- **THEN** each page exists and contains command reference, examples, and related commands

openspec/changes/docs-09-missing-command-docs/tasks.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,6 @@
2929
## 6. Verification
3030

3131
- [ ] 6.1 Validate all command examples against `--help` output
32-
- [ ] 6.2 Verify all internal links resolve
33-
- [ ] 6.3 Run `bundle exec jekyll build` with zero warnings
32+
- [ ] 6.2 Verify command docs that mention prompts/templates use bundle-owned resource language consistent with `packaging-01-bundle-resource-payloads`
33+
- [ ] 6.3 Verify all internal links resolve
34+
- [ ] 6.4 Run `bundle exec jekyll build` with zero warnings

openspec/changes/docs-10-workflow-consolidation/proposal.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Multiple brownfield guides overlap (brownfield-engineer, brownfield-journey, bro
1313
- Write new `workflows/daily-devops-routine.md`: morning standup -> refine -> commit -> review cycle
1414
- Write new `workflows/ci-cd-pipeline.md`: CI integration patterns with SpecFact commands
1515
- Validate and update existing `command-chains.md` against current command surface
16+
- Fold bundle-owned prompt/template setup into the workflow docs where IDE export or workspace-template bootstrap is a prerequisite, so resource migration does not require a separate follow-up docs change
1617

1718
## Capabilities
1819

@@ -30,6 +31,7 @@ Multiple brownfield guides overlap (brownfield-engineer, brownfield-journey, bro
3031
- New files: `workflows/cross-module-chains.md`, `workflows/daily-devops-routine.md`, `workflows/ci-cd-pipeline.md`
3132
- Merged files: brownfield-engineer + brownfield-journey -> brownfield-modernization, brownfield-faq + brownfield-roi -> brownfield-faq-and-roi, 3 examples -> brownfield-examples
3233
- Updated: `workflows/command-chains.md` (validated against current commands)
34+
- Aligns with: `packaging-01-bundle-resource-payloads` for module-owned prompt/template setup steps
3335
- Depends on: `docs-06-modules-site-ia-restructure`
3436

3537
## Source Tracking
Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
# Capability: cross-module-workflow-docs
2-
3-
Documented end-to-end flows showing how to chain commands across multiple bundles.
4-
5-
## Scenarios
6-
7-
### Scenario: Cross-module chain covers full lifecycle
8-
9-
Given the cross-module-chains workflow doc
10-
When a user reads the page
11-
Then it shows a complete flow: backlog ceremony -> code import -> spec validate -> govern enforce
12-
And each step shows the exact command with practical arguments
13-
14-
### Scenario: Daily routine covers a full work day
15-
16-
Given the daily-devops-routine workflow doc
17-
When a user reads the page
18-
Then it shows: morning standup, refinement, development, review, and end-of-day patterns
19-
And each step links to the relevant bundle command reference
20-
21-
### Scenario: CI pipeline doc covers automation patterns
22-
23-
Given the ci-cd-pipeline workflow doc
24-
When a user reads the page
25-
Then it shows: pre-commit hooks, GitHub Actions integration, and CI/CD stage mapping
26-
And all specfact commands shown are valid and current
1+
## ADDED Requirements
2+
3+
### Requirement: Workflow docs SHALL cover current cross-module flows and setup prerequisites
4+
Workflow documentation SHALL show valid multi-bundle command chains and include resource-bootstrap steps when migrated bundle-owned prompts or templates are prerequisites.
5+
6+
#### Scenario: Cross-module chain covers full lifecycle
7+
- **GIVEN** the `cross-module-chains` workflow doc
8+
- **WHEN** a user reads the page
9+
- **THEN** it shows a complete flow such as backlog ceremony -> code import -> spec validate -> govern enforce
10+
- **AND** each step shows the exact command with practical arguments
11+
12+
#### Scenario: Daily routine covers a full work day
13+
- **GIVEN** the `daily-devops-routine` workflow doc
14+
- **WHEN** a user reads the page
15+
- **THEN** it shows morning standup, refinement, development, review, and end-of-day patterns
16+
- **AND** each step links to the relevant bundle command reference
17+
18+
#### Scenario: Workflow docs explain resource bootstrap before dependent flows
19+
- **GIVEN** a workflow doc that uses AI IDE prompts or backlog workspace templates
20+
- **WHEN** a user reads the page
21+
- **THEN** the workflow includes the supported resource bootstrap step such as `specfact init ide`
22+
- **AND** it does not rely on legacy core-owned resource paths
23+
24+
#### Scenario: CI pipeline doc covers automation patterns
25+
- **GIVEN** the `ci-cd-pipeline` workflow doc
26+
- **WHEN** a user reads the page
27+
- **THEN** it shows pre-commit hooks, GitHub Actions integration, and CI/CD stage mapping
28+
- **AND** all SpecFact commands shown are valid and current

0 commit comments

Comments
 (0)