Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.3.3"
".": "0.3.4"
}
59 changes: 59 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,65 @@
Paths in entries before v0.3.0 use the old layout. The v0.3.0 entry has a "Moved" table from each old path to its new
one.

## [0.3.4](https://github.com/Nistapp/codebase-agentic-readiness-framework/compare/v0.3.3...v0.3.4) (2026-11-10)

### Features

- **dev:** add adr-lint to make check ([58c5307](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/58c53072ac41068885aae235d9191419ef792495))
- **dev:** adr-lint checks the engine index and mentions of missing ADRs ([2a492e5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/2a492e5a73f4db965b506dbef03db77d63b454ab))
- **dev:** adr-lint checks the engine index and mentions of missing ADRs ([090de46](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/090de4644770088ab3930473c802fe6cb4b3458b))
- **engine:** DOC-04 flags superseded, deprecated or rejected ADRs ([568bc5c](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/568bc5c11c5f929c00db9aac0c41181e3dfdeca1))
- **implement:** add a prose check template for target repositories ([b4e5fbe](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/b4e5fbed579727bb2f9a339dd6a116e164fa7848))
- **implement:** bring the writing rules to target repositories (v0.3.6) ([8ec7fee](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/8ec7fee7c5f60ba6dc4b95a1526a91b99e69aaaa))
- record the ADR policy in ADR 0009 and check it (DOC-04, adr-lint) ([c304ee5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/c304ee56cbf02d52d3143b3b376f771b80b57f48))

### Bug fixes

- **engine:** add the tool-07-guard-no-exit eval file to the secrets baseline ([54c10e0](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/54c10e030c14a56edef057d6f82e554eeda5e946))
- **engine:** EXEC-01 reads every module of a pinned ecosystem ([86cab41](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/86cab41d9f27e5c4a6191e45f1ecbc1855816c10))
- **engine:** TOOL-07 needs a guard that exits non-zero ([71b4e61](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/71b4e616f1ea8d48746c1c68e6ccc49a5b81cd08))
- **eval:** regenerate the eval-expected files with the current paths ([0ccd527](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/0ccd527015468f70ba2221040e42f9a2b1b4709d))
- **implement:** store commit ids in the state as 12 digits ([ddf8b05](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/ddf8b05d1e64eaa670239af84abfb7d4a52549cf))
- **skills:** resolve every link the audit bundle keeps ([6a98a5d](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/6a98a5dd6cd7acba2a95c728867d9bbe50d4a3cf))

### Documentation

- add the agent-tuned ADR policy and a lean template ([46e6577](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/46e6577ff00d522392b27fee32c5ac8c8889588d))
- an agent-tuned ADR policy, a lean template and every ADR converted ([b735040](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/b73504045eacc88b6ca6efa7225ef4706986ec83))
- convert the audit ADR to the lean template ([274b16d](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/274b16d9f5b88be260639bdf72841d2fbacd7662))
- convert the engine ADRs to the lean template ([a1327e5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/a1327e56dbf425ac121e9577dfc1feb287d5b143))
- convert the implement ADRs to the lean template ([81ab990](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/81ab9907d80ce6387f4da2155f9842085e17c3d5))
- convert the root ADRs to the lean template ([1d3b048](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/1d3b048fc46ee4b2eb331e218ed6282fcedca133))
- convert the spec decision records to the lean template ([221fff3](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/221fff3c203b135307403d1cc353a9aded2a9ded))
- describe how the implement recipe brings the writing rules to a target ([907fd76](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/907fd7697b8f2b4bf848d3e0f5a0c98a8598f11c))
- give ADR 0005 the current reason to reject a back-merge from main ([111fedb](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/111fedbac771f7d5618e809c0157ce5a4002b930))
- **greenfield:** ship the ADR policy and the lean template ([83ce5b8](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/83ce5b83f1bfc7f471a13ab21755ea23080ae6fa))
- **implement:** add plain-language and diagram rules to the style guide ([4d78aea](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/4d78aea9ed46d9b960d97fa088c2877a736b1ebd))
- **implement:** add the Dependabot pre-commit ecosystem to step 8 ([9db8c0b](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/9db8c0b325cab76cc281af01ed46a8e49d1d6fed))
- **implement:** confirm the GitLab variables of the source-branch job ([18ec3b3](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/18ec3b3f58c48d8bd30a7591abd1b29447736839))
- **implement:** count only warnings in the target's prose ratchet ([9c7ba80](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/9c7ba80b4020fa8844cb4c6c754b7d7477e804cc))
- **implement:** limit prose check copies to three permissive licences ([d2bf4ca](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/d2bf4ca2a7e24b2f393cff7588f14dfdac83b51a))
- **implement:** name what triggers the AGT-12 and DOC-05 steps ([31f9a9a](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/31f9a9a36cbd67052ce2f092e4cdd311347cc973))
- **implement:** record existing prose debt instead of rewriting it ([4a1f495](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/4a1f49525e93d720b981d1ad9f6294e1fdd0fc6d))
- **implement:** use the shared message layouts in the two playbooks ([2aa044e](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/2aa044eba06793844923dfa8c9c8794a8dc8970b))
- **implement:** write a "How to write for people" section in adapt-agents-md ([87940ae](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/87940ae60a09c79d6fc2bf45f747e034841869fc))
- **implement:** write ADRs into targets under the ADR policy ([8abd227](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/8abd2273a83b47cbf318d9da11da4ca8046e9d5c))
- **implement:** write the Renovate security-only form from Renovate's docs ([af0b6a1](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/af0b6a1e9ea2d78326561f6faf0e61e6f7d09478))
- license the greenfield templates under MIT-0 ([786fba5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/786fba5a2c3e437e374a9a5f81e93f0bae4a1f20))
- license the greenfield templates under MIT-0 ([93c6b66](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/93c6b66c4e5482e8b86b98dd354b35a3a533cf0c))
- point every agent file and router at the ADR policy ([ad0e4b5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/ad0e4b5537bd296a0c135a32a07dddf912c7b128))
- record why ADRs hold only the current decision (ADR 0009) ([30ac7e5](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/30ac7e56f1e886a008146bcffd07f98284b152fa))
- replace ADR index status and date columns with summaries ([9bf7534](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/9bf7534bb42f83865ddca5319f0b229310c146dd))
- restore the two style guide headings an edit merged ([c9dc09f](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/c9dc09f12e7cd146061d5d8c49f4c8f7354ac2d0))
- **spec:** let any verb run the dependency scan in REQ-SH-030 ([5182077](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/518207775a3653fa2ba531672b5d9728eead3526))
- word the AGENTS.md ADR pointer as a rule, not a deferral ([52fe131](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/52fe1312761ff8491a6dc7587a2e1b671ca8e32d))

### CI and release

- run the eval-expected check in make check ([d25eae4](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/d25eae4558695621aa9d7cd0489a860c795e780d))
- shard the dev checks in the Python 3.14 test parts ([2dd517d](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/2dd517d87304fe4962e5caaebb51227692a33cc7))
- shard the dev checks in the Python 3.14 test parts ([4bac0ca](https://github.com/Nistapp/codebase-agentic-readiness-framework/commit/4bac0caed1a11323f6fd908be5ec16b4ecb45a7b))

## [0.3.3](https://github.com/Nistapp/codebase-agentic-readiness-framework/compare/v0.3.2...v0.3.3) (2026-11-10)

### Features
Expand Down Expand Up @@ -258,18 +317,18 @@

### Start in one minute

- Clone the repository, start Claude Code in it, and say "Audit `<repo>` and write the output to `<dir>`", then

Check notice on line 320 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 28 words (limit 25)
"Start implementing the fixes on `<repo>` based on `<report>.json`". Two tracked pointer skills in
`.claude/skills/` start the recipes `audit/SKILL.md` and `implement/SKILL.md`; `dev/tests/test_pointer_skills.py`
keeps them in step (V03.U1).
- The root `README.md` is short and user-first: the quick start, a table of other ways in, an honest platform

Check notice on line 324 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 35 words (limit 25)
statement (Linux tested; macOS tools tested in CI; Windows not tested) and the licences (V03.B1, V03.C2).
- New how-to: [install the skills from a release](docs/how-to/install-the-skills.md), with the checksum check.
- The worked example links the public Server repository at the commit after the fixes (V03.X1).

### Repository

- New layout (V03.C1): `docs/` (framework pages and the Diátaxis docs), `spec/` (unchanged), `greenfield/`,

Check warning on line 331 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 41 words (limit 25)
`audit/` (recipe, catalogue, schemas, stacks, tools, and the engine with its own docs), `implement/` (recipe, tools,
its ADRs) and `dev/` (build, lint, eval and CI-only checks; never shipped). Moves are `git mv`, so
`git log --follow` keeps each file's history.
Expand All @@ -279,7 +338,7 @@
same shape as the clone. Unzip a new release over the old folders. Bundles build into `dev/dist/skills/`.
- `SECURITY.md`: report a vulnerability privately through GitHub, or by email to `udan-security@nistapp.com`;
acknowledgement within 5 working days (V03.D2).
- `main` is protected by a ruleset (pull request, `CI Gate`, up to date, no force push or deletion, merge commit), and

Check notice on line 341 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 37 words (limit 25)
private vulnerability reporting, secret scanning, push protection and Dependabot security updates are on
([branch protection](docs/reference/branch-protection.md), V03.D1, V03.D3).
- The `register-index` playbook recommends `.mcp.json` at the repository root as the one MCP config (V03.A1).
Expand Down Expand Up @@ -314,13 +373,13 @@

### Framework pages (since v0.1)

- A quality baseline for this repository, by the `add-baselines-and-ratchet` playbook: `.quality-baseline.json` and a

Check notice on line 376 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 28 words (limit 25)
compare step that fails when the ruff, mypy or Markdown lint count goes up (MR08.3).

- The framework pages say the implement recipe is in development and no longer promise features that are only

Check notice on line 379 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 39 words (limit 25)
planned; the verb count is seven everywhere; the greenfield README and `AGENTS.md` template (now 1.1.1) state what
the scaffold satisfies (MR01.3).
- Decisions of record: the push and pull request policy ([ADR 0003](implement/docs/architecture/adrs/0003-push-and-pr-policy.md)),

Check notice on line 382 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 29 words (limit 25)
`format:check` includes the lint rules ([spec decision 0002](spec/decisions/0002-lint-in-the-gate.md)), and a note
that monorepo component scoping is v0.3 (MR03).
- The risk register names the risks the recipes introduce, R9-R14 (MR08).
Expand All @@ -328,13 +387,13 @@

### This repository's own gates

- Phase 1 for this repository (MR07): `.python-version`, lefthook hooks, `make setup`, `make coverage` with a

Check notice on line 390 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 35 words (limit 25)
floor, a root `docs/` index with a branch-protection page, issue and pull request templates, and secret and key
material ignored by shape.
- The self-audit is published and ratcheted: `make self-audit` against `.audit-baseline.json`, a `self-audit` job in
`CI Gate`, and [Self-Audit](docs/reference/self-audit.md) (MR07.2).
- `recipe_lint.py` checks the relative links of the root `README.md`, `shared/`, `spec/`, `greenfield-bootstrap/` and
`brownfield-legacy/` as part of `make check` (MR08).
- `CONTRIBUTING.md`, this changelog, `RELEASE_PROCESS.md`, a Dependabot schedule for the workflow actions, and a

Check notice on line 397 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / docs

PL001

sentence has 27 words (limit 25)
release workflow that attaches `audit.pyz` and the skill bundle to a tagged release (MR08). The workflow has not
run yet.
2 changes: 1 addition & 1 deletion audit/engine/audit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

from __future__ import annotations

__version__ = "0.3.3" # x-release-please-version
__version__ = "0.3.4" # x-release-please-version

#: Bumped whenever a rule pack, a check, or the instruction-variant table changes.
#: Recorded in every report's provenance block so a report can be attributed to an
Expand Down
2 changes: 1 addition & 1 deletion audit/tools/report.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
)

#: The framework release these tools belong to: `provenance.framework.release`. release-please rewrites the line.
FRAMEWORK_RELEASE = "0.3.3" # x-release-please-version
FRAMEWORK_RELEASE = "0.3.4" # x-release-please-version
SCHEMA_VERSION = "0.2"
DRAFT_KIND = "audit-draft"
DEFAULT_PROBE_TIMEOUT_S = 120
Expand Down
2 changes: 1 addition & 1 deletion implement/tools/progress.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
import validate_report

#: The framework release these tools belong to: the state's `framework.release`. release-please rewrites the line.
FRAMEWORK_RELEASE = "0.3.3" # x-release-please-version
FRAMEWORK_RELEASE = "0.3.4" # x-release-please-version
SCHEMA_VERSION = "0.3"

RECIPES = Path(__file__).resolve().parent.parent
Expand Down
Loading