Skip to content

Latest commit

 

History

History
242 lines (217 loc) · 17 KB

changelog.md

File metadata and controls

242 lines (217 loc) · 17 KB

changelog.md

Lightweight human-readable summary of meaningful repository changes.

Unreleased

  • Added scalable GitHub governance: structured Issue Forms, source-controlled label taxonomy, path-based PR labels, new-issue triage, weekly grouped Dependabot updates targeting develop, and a dormant CODEOWNERS draft.
  • Added ruff and strict dependency-audit CI gates, upgraded the supported Python floor to 3.10, and added regression tests for repository governance configuration.
  • Hardened CI supply chain behavior: replaced the Antigravity curl | bash installer with a versioned SHA-512-verified artifact, pinned release Actions to commit SHAs, pinned release build tooling, and removed PR-title shell expression injection.
  • Corrected the governance audit to recognize the already-active repository branch/tag rulesets through the ruleset APIs rather than treating a classic branch-protection 404 as proof of no protection.
  • Enabled live Discussions, dependency security updates and alerts, secret scanning with push protection, private vulnerability reporting, and automatic deletion of merged branches.
  • Added a Cline CLI adapter (adapters/cline/) so Cline CLI and ClinePass users can install the skills/adr-toolkit package. Cline installs skills through the open Agent Skills standard (SKILL.md), so the adapter is README-only — no manifest — documenting cline skill add SHcommit/ADR-toolkit plus a manual symlink fallback. Manually verified against Cline CLI 3.0.61.
  • Expanded improvements.md backlog with High and Medium priority items: ReDoS cross-platform safety, 2-phase atomic transaction rollback for supersede, ADR overlap/similarity Eval framework, weekly automated maintenance workflows, PR significance bot, adr lint --fix auto-repair, interactive HTML graph viewer, and code drift detection.
  • Logged a Medium-priority backlog item to fold the Cline CLI adapter into the harness-parity CI job (currently manually verified against Cline CLI 3.0.61 only), so Cline/ClinePass version drift is caught automatically like the Codex, Gemini, and Antigravity adapters.
  • Added CLINE.md as a thin harness entry pointer (matching CODEX.md/CLAUDE.md/GEMINI.md) and updated AGENTS.md to list Cline alongside the other harnesses, plus an explicit note that per-model files (DEEPSEEK.md/GLM.md/KIMI.md/QWEN.md) are intentionally not created — those are model providers routed through a harness, not harnesses themselves. Verified that Cline (CLI 3.0.61 with cline-pass/glm-5.2) auto-injects the repo-root AGENTS.md into workspace context at session start, so the shared operating document reaches every model routed through ClinePass without a per-model entry file.

v1.1.2 (2026-09-12)

Documentation release:

  • Added a GitHub-friendly README language switcher with release/status badges and moved translated README variants under docs/readme/ to keep the repository root uncluttered.
  • Bumped skills/adr-toolkit/VERSION, SKILL.md frontmatter, adapter manifests, and pyproject.toml to 1.1.2 via scripts/sync_version.py.

v1.1.1 (2026-09-06)

Hotfix release to close two gaps discovered while deploying v1.1.0:

  • Fixed .claude-plugin/marketplace.json to conform to the Claude Code v2.1.263 marketplace schema by adding the required owner field plus $schema and a top-level description. claude plugin marketplace add <repo> previously failed with Invalid schema: ... owner: Invalid input, blocking fresh installs even though the shipped plugin.json was already correct. Mirrors the working Agent-toolkit/.claude-plugin/marketplace.json shape.
  • Extended scripts/sync_version.py to also sync the version = "..." field under pyproject.toml's [project] table. The v1.1.0 release shipped a GitHub Release whose skill tarball was v1.1.0 but whose Python wheel/sdist were 1.0.1, because pyproject.toml's version was not in the sync surface and release.yml only verified the skill VERSION against the tag. The new TOML_VERSION_SPECS list + sync_toml_version() rewrite the version = "..." line in-place by regex (Python 3.10 stdlib has no TOML writer, tomli is read-only). require_known_paths() now also checks the [project] table is present, so a future structural edit that deletes the table fails loudly instead of silently dropping pyproject.toml out of the drift check.
  • Added regression tests in tests/unit/test_sync_version.py that pin the new behavior: writes version under [project], leaves version under other tables untouched, is idempotent, supports --check, skips when the section is missing — plus a real-repo guard (test_real_pyproject_version_matches_skill_version) that fails the moment pyproject.toml drifts from skills/adr-toolkit/VERSION again.
  • Bumped skills/adr-toolkit/VERSION, SKILL.md frontmatter, and every adapter manifest (.claude-plugin/plugin.json, adapters/gemini-cli/gemini-extension.json, adapters/antigravity/plugin.json, plus pyproject.toml) to 1.1.1 via scripts/sync_version.py.

v1.1.0 (2026-09-06)

Minor release: new features, governance hardening, and a new harness adapter.

  • Added a Cline CLI adapter (adapters/cline/) so Cline CLI and ClinePass users can install the skills/adr-toolkit package. Cline installs skills through the open Agent Skills standard (SKILL.md), so the adapter is README-only — no manifest — documenting cline skill add SHcommit/ADR-toolkit plus a manual symlink fallback. Manually verified against Cline CLI 3.0.61.
  • Added CLINE.md as a thin harness entry pointer (matching CODEX.md/CLAUDE.md/GEMINI.md) and updated AGENTS.md to list Cline alongside the other harnesses, plus an explicit note that per-model files (DEEPSEEK.md/GLM.md/KIMI.md/QWEN.md) are intentionally not created — those are model providers routed through a harness, not harnesses themselves. Verified that Cline (CLI 3.0.61 with cline-pass/glm-5.2) auto-injects the repo-root AGENTS.md into workspace context at session start, so the shared operating document reaches every model routed through ClinePass without a per-model entry file.
  • Scalable GitHub governance: structured Issue Forms, source-controlled label taxonomy, path-based PR labels, new-issue triage, weekly grouped Dependabot updates targeting develop, and a dormant CODEOWNERS draft.
  • Ruff and strict dependency-audit CI gates, upgraded the supported Python floor to 3.10, and added regression tests for repository governance configuration.
  • Hardened CI supply chain: replaced the Antigravity curl | bash installer with a versioned SHA-512-verified artifact, pinned release Actions to commit SHAs, pinned release build tooling, and removed PR-title shell expression injection.
  • Corrected the governance audit to recognize the already-active repository branch/tag rulesets through the ruleset APIs rather than treating a classic branch-protection 404 as proof of no protection.
  • Enabled live Discussions, dependency security updates and alerts, secret scanning with push protection, private vulnerability reporting, and automatic deletion of merged branches.
  • Recorded ADR-0017 (OSS repository governance & supply-chain hardening decision).
  • Logged a Medium-priority backlog item to fold the Cline CLI adapter into the harness-parity CI job (currently manually verified against Cline CLI 3.0.61 only), so Cline/ClinePass version drift is caught automatically like the Codex, Gemini, and Antigravity adapters.
  • Expanded improvements.md backlog with High and Medium priority items: ReDoS cross-platform safety, 2-phase atomic transaction rollback for supersede, ADR overlap/similarity Eval framework, weekly automated maintenance workflows, PR significance bot, adr lint --fix auto-repair, interactive HTML graph viewer, and code drift detection.
  • Synced skills/adr-toolkit/VERSION, SKILL.md frontmatter, and the Claude / Gemini / Antigravity / Codex manifests to 1.1.0 via scripts/sync_version.py.

v1.0.1 (2026-09-02)

  • Added PyPI packaging support (pyproject.toml) for pip install adr-toolkit and pipx install adr-toolkit.
  • Integrated PyPI Trusted Publisher OIDC pipeline (pypa/gh-action-pypi-publish@release/v1) into .github/workflows/release.yml.
  • Synced all plugin manifests and version references across Claude, Codex, Gemini, and Antigravity adapters to v1.0.1.

v1.0.0 (2026-09-02)

  • First Official Major Production Release (1.0.0):
    • Resolved all Production Readiness audit findings across Operability, Reliability, Observability, Maintainability, and Recoverability.
    • Operability (Group A): Added .adr-toolkit.json adr_dir config key support and ADR_DIR, ADR_LOCALE environment variable overrides with resolve_adr_dir() precedence.
    • Reliability (Group B): Added SIGINT/SIGTERM signal trap handling in atomic_io.py and PID/timestamp lock metadata with automatic stale lock detection and breaking (is_lock_stale, break_stale_lock).
    • Maintainability (Group C): Refactored 41KB scripts/adoption_metrics.py into modular scripts/adoption_metrics/ subpackage while preserving backwards compatibility wrappers.
    • Recoverability (Group D): Implemented new adr doctor diagnostic command (skills/adr-toolkit/scripts/commands/doctor.py) for automated config, frontmatter, and lock health inspection.
    • Reliability & Performance (Group E): Added 10MB file size cap and memory-safe parse_file() in frontmatter.py. Verified 500+ synthetic ADR scale performance under 0.5s.
    • Observability (Group F): Added standard Python logging with --verbose, --debug, and --quiet CLI flags in adr.py, and registered the doctor subcommand.
    • Full test suite passed (550 unit and integration test cases) with zero external runtime dependencies (100% Python stdlib).

v0.3.2 (2026-09-02)

  • Cleared completed work out of improvements.md's ## Done section and handoff.md's completed-task narrative, per both files' own documented steady-state convention (resolved items live in this changelog, git history, and docs/decisions/ instead). No functional changes.

v0.3.1 (2026-09-02)

  • Fixed the release workflow: GitHub's Artifact Attestation API rejects attestation for a user-owned private repository, which broke the v0.3.0 tag's release run before it could publish anything (that tag exists in git history but has no corresponding GitHub Release -- this release supersedes it). .github/workflows/release.yml now skips the attestation step while this repository is private and will start running it automatically once the repository goes public; the packaged archive and its SHA-256 checksum are unaffected and still published on every release. SECURITY.md documents this.

v0.3.0 (2026-09-02)

  • Recorded this release's architectural decisions as ADR-0012 through ADR-0016 (atomic writes + directory locking, the two-stage ReDoS guard, typed result contracts + mypy --strict, structured JSON logging with correlation IDs, and release artifact attestation), using the ADR toolkit itself.
  • .github/workflows/release.yml now packages skills/adr-toolkit/ into a version-named tarball, SHA-256 checksums it, and generates a Sigstore-backed GitHub Artifact Attestation (actions/attest-build-provenance@v2, keyless) for it; the tarball and checksum are attached to the GitHub Release. SECURITY.md documents how to verify a downloaded release archive.
  • Added scripts/adoption_metrics.py, a JSON-only collector for the five enterprise adoption metrics defined in docs/enterprise-adoption.md: decision lead time, review latency, supersession rate, unresolved CHECK violations, and exception age. It combines portable ADR/exception data with optional local Git, explicit JSONL event, CHECK snapshot, and GitHub review evidence while reporting source coverage and incomplete-evidence warnings.
  • core/contracts.py now covers all 16 commands' output shapes (was 2).
  • PathEscapesRootError (added in the prior session's path-escape fix) is now caught at all 7 call sites and reported as a structured PATH_ESCAPES_ROOT error instead of falling through to a generic internal error. All 6 domain exception classes now share a common AdrToolkitError base with a stable error_code.
  • Added a test that fails if schemas/*.json and the runtime validators in core/schema.py/core/exceptions.py ever diverge -- without adding a jsonschema dependency.
  • core/contracts.py now also covers CHECK's result shape.
  • Added a sanity check proving search/index don't degrade catastrophically at 200 ADRs.
  • adr.py now prints a one-line human-readable summary to stderr when stderr is a real terminal (set ADR_TOOLKIT_NO_COLOR to suppress); stdout's JSON contract and piped/redirected usage are unaffected.
  • --dir/--root now reject a relative path that resolves outside the given root, closing a path-escape gap.
  • CI now measures branch coverage (currently 93%) and fails below 85%.
  • Added a mypy --strict CI gate over the fully-typed core modules (atomic_io, telemetry, the new contracts module of TypedDict result shapes).
  • Added adr.py --diagnostic (must precede the operation name) to include an elapsed_ms timing field in the JSON result.
  • Verified at the OS level (fork + SIGKILL) that a process killed mid-write never leaves a torn ADR file.
  • Extracted a shared adapter-manifest validator (scripts/adapter_sdk.py) used by all 4 manifest-based harness adapters' tests.
  • ADR and exception creation, and SUPERSEDE's two-file update, are now atomic and race-free under concurrent invocation (file locking + write to a temp file followed by an atomic rename).
  • CHECK's author-supplied constraints: regex patterns now have a 0.25s evaluation timeout on Linux/macOS, closing a ReDoS risk (Windows CI is unaffected but not yet guarded — tracked in improvements.md).
  • INDEX's generated decision-log README now escapes ADR titles, closing a Markdown link-injection risk.
  • Uncaught errors now log a structured, correlation-ID-tagged JSON line to stderr (ADR_TOOLKIT_LOG_LEVEL controls the threshold) instead of disappearing silently; the same correlation ID appears in the stdout JSON error response.
  • Added .githooks/pre-push script to block direct local git push to protected branches (develop, master) and direct contributors to use Pull Requests (feature/* / fix/*).
  • Added Conventional Commits PR title validation job (pr-title-check) to GitHub Actions workflow (.github/workflows/test.yml) to enforce standard title format (feat:, fix:, docs:, etc.) for pull requests.
  • Updated .github/PULL_REQUEST_TEMPLATE.md with Conventional Commits title format guide and an explicit Examples Impact checklist requiring example updates for feat: and fix: changes while skipping non-feature PRs.
  • Fixed Windows CP1252 console encoding failure (UnicodeEncodeError: 'charmap' codec can't encode character '✓') in scripts/verify_examples.py and tests/integration/test_examples.py by replacing non-ASCII symbols with ASCII tags ([ok], [error]), reconfiguring stdout/stderr UTF-8 streams, and setting PYTHONIOENCODING=utf-8 in subprocess calls.
  • Added untracked manifest discovery (discover_untracked_manifests) in scripts/sync_version.py to automatically prevent untracked plugin/extension manifests from being added in PRs without version/description tracking.
  • Added .pre-commit-config.yaml for local contributor pre-commit checks and updated CONTRIBUTING.md with manifest governance guidelines.
  • Enhanced Antigravity CLI (agy) plugin manifest (adapters/antigravity/plugin.json) with version tracking integrated into scripts/sync_version.py, expanded unit test assertions in test_antigravity_adapter.py (including symlink layout simulation) and test_readme.py, and updated README.md documentation.

v0.2.1 (2026-08-31)

  • Redesigned and expanded examples/ into representative, structured usage guides (basic-usage.md, check-constraints.md, graph-visualization.md, and multilingual-adr.md) with standardized Scenario, Input, What Happens, and Output sections.

  • Added a full Korean documentation suite under examples/ko/ (including basic-usage.md, check-constraints.md, graph-visualization.md, and multilingual-adr.md).

  • Created scripts/verify_examples.py and tests/integration/test_examples.py to automatically verify that all documented example commands execute cleanly and to auto-update example output snippets when core adr.py logic or schemas change.

  • Added a harness-parity CI job that installs the real Codex CLI and Gemini CLI and drives their own plugin/extension commands (marketplace add, install, list) against this repo, then runs preflight/init/ validate from the installed snapshot on every push and pull request — catching a broken adapter before a user hits it, not after.

  • Added public repository readiness docs: CONTRIBUTING.md, SECURITY.md, and a pull request template covering ADR impact and local verification.