Skip to content

Commit f67c3ab

Browse files
montfortclaude
andcommitted
docs: fix CLAUDE.md — correct release workflow, commands, and test count
- Framework release workflow: document tag-based CI trigger (git tag + git push) instead of gh release create, list all docs to update - CLI release: expand docs-to-update list (EN+ES CLI-REFERENCE, READMEs) - Commands table: add validate, compliance, metrics, audit (9 → 13) - Test count: 26 → 95 - Add chrono to key dependencies Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 21e03b2 commit f67c3ab

1 file changed

Lines changed: 52 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,11 @@ version = "X.Y.Z"
6060

6161
Run `cargo check` in `cli/` to update `Cargo.lock`.
6262

63-
Update version references in docs if they mention the CLI version:
64-
- `docs/adopters/CLI-REFERENCE.md` (status example output)
63+
Update version references in all docs that mention version numbers:
64+
- `docs/adopters/CLI-REFERENCE.md` (EN — versioning table + example outputs)
65+
- `docs/i18n/es/adopters/CLI-REFERENCE.md` (ES — same)
66+
- `README.md` (versioning table)
67+
- `docs/i18n/es/README.md` (ES — versioning table)
6568

6669
### Step 2: Commit and merge
6770

@@ -116,17 +119,51 @@ Users can now run `devtrail update-cli` to get the new version.
116119

117120
## Release Workflow — Framework
118121

119-
Framework releases are simpler (no binaries to compile):
122+
Framework releases are automated via `release-framework.yml`. The workflow triggers on tag push (`fw-*`), packages `dist/` as a ZIP, and creates the GitHub release with the asset.
123+
124+
### Step 1: Bump version
125+
126+
Edit `dist/dist-manifest.yml`:
127+
```yaml
128+
version: "X.Y.Z"
129+
```
130+
131+
Update version references in docs:
132+
- `docs/adopters/CLI-REFERENCE.md` (EN — versioning table)
133+
- `docs/i18n/es/adopters/CLI-REFERENCE.md` (ES — versioning table)
134+
- `README.md` and `docs/i18n/es/README.md` (versioning tables)
135+
- `dist/.devtrail/00-governance/QUICK-REFERENCE.md` (EN + ES footer)
136+
- `dist/.devtrail/00-governance/AGENT-RULES.md` (EN + ES footer)
137+
138+
### Step 2: Commit and merge
139+
140+
```bash
141+
git checkout -b chore/bump-fw-X.Y.Z
142+
git add dist/ docs/ README.md
143+
git commit -m "chore: bump Framework version to X.Y.Z"
144+
# Push, create PR, merge to main
145+
```
146+
147+
### Step 3: Create and push tag
120148

121149
```bash
122-
# 1. Update dist/dist-manifest.yml version
123-
# 2. Commit, merge to main
124-
# 3. Create release:
125-
gh release create fw-X.Y.Z \
126-
--title "DevTrail Framework X.Y.Z" \
127-
--notes "Release notes..."
150+
git tag fw-X.Y.Z
151+
git push origin fw-X.Y.Z
128152
```
129153

154+
The `release-framework.yml` workflow triggers automatically:
155+
1. Packages `dist/` contents into `devtrail-fw-X.Y.Z.zip`
156+
2. Creates the GitHub release with the ZIP as asset
157+
158+
### Step 4: Verify
159+
160+
```bash
161+
gh release view fw-X.Y.Z --json assets --jq '.assets[].name'
162+
# Should show: devtrail-fw-X.Y.Z.zip
163+
```
164+
165+
Users can now run `devtrail update-framework` to get the new version.
166+
130167
## CLI Commands Reference
131168

132169
| Command | Description |
@@ -138,6 +175,10 @@ gh release create fw-X.Y.Z \
138175
| `devtrail remove [--full]` | Remove DevTrail from project |
139176
| `devtrail status [path]` | Show installation health and doc stats |
140177
| `devtrail repair [path]` | Restore missing directories and framework files |
178+
| `devtrail validate [path]` | Validate documents for compliance and correctness |
179+
| `devtrail compliance [path]` | Check regulatory compliance (EU AI Act, ISO 42001, NIST) |
180+
| `devtrail metrics [path]` | Show governance metrics and documentation statistics |
181+
| `devtrail audit [path]` | Generate audit trail reports with timeline and traceability |
141182
| `devtrail explore [path]` | Interactive TUI documentation browser |
142183
| `devtrail about` | Show version and license info |
143184

@@ -155,7 +196,7 @@ cargo build --no-default-features # Without TUI
155196
### Test
156197

157198
```bash
158-
cargo test # All 26 tests
199+
cargo test # All 95 tests
159200
```
160201

161202
### Feature Flags
@@ -175,4 +216,5 @@ cargo test # All 26 tests
175216
| `pulldown-cmark` | Markdown parser (optional) |
176217
| `reqwest` | HTTP client for downloads |
177218
| `serde_yaml` | YAML parsing |
219+
| `chrono` | Date parsing (metrics, audit) |
178220
| `anyhow` | Error handling |

0 commit comments

Comments
 (0)