Skip to content

Releases: EffortlessMetrics/Rust-Template

v3.3.14

30 Dec 00:11

Choose a tag to compare

What's Changed

Changed

  • Pre-commit hook behavior

    • Hook is blocking by default (--mode fast --staged-only)
    • Escape hatch: git commit --no-verify bypasses the hook
    • Only significant changes (Rust, BDD features, specs) trigger checks
    • Auto-formats and auto-stages mechanical fixes (rustfmt, skills-fmt)
    • Staged-only Rust commits require no unstaged Rust-affecting changes
  • Pre-commit xtask improvements

    • Added --mode fast|full flag (fast is default)
    • Added --staged-only flag to check only staged files
    • Smart change detection skips checks when no significant files changed
    • Clearer output indicating mode and scope
  • Acceptance test cleanup

    • Worktree cleanup on test completion to prevent temp directory accumulation
    • Proper cleanup on both success and failure paths

Docs

  • Updated ROADMAP §4.4.1 to reflect blocking hook behavior
  • Clarified hook knobs and behavior model in documentation

Receipts: cargo xtask docs-check ✓, cargo xtask selftest (11/11) ✓

Evidence:

v3.3.12

23 Dec 05:16

Choose a tag to compare

What's Changed

Full Changelog: v3.3.11...v3.3.12


Notes:

  • Documentation refresh landed on main in PR #34 (post-tag).

v3.3.11

12 Dec 10:47

Choose a tag to compare

Release v3.3.11

v3.3.10

12 Dec 08:54

Choose a tag to compare

Release v3.3.10 - Version alignment and governance fixes

v3.3.9

12 Dec 05:38

Choose a tag to compare

Release v3.3.9

v3.3.8

12 Dec 03:50

Choose a tag to compare

Release v3.3.8

Rust-as-Spec Kernel v3.3.8

10 Dec 01:00

Choose a tag to compare

Rust-as-Spec Kernel v3.3.8

This release marks the v3.3.8 kernel as IDP-ready with comprehensive governance, introspection APIs, and AI-native onboarding.

Key Changes

  • Version alignment to v3.3.8 across all governed documents
  • Fixed AC-TPL-AGENT-HINTS - Added ?kind=task|governance filter to /platform/agent/hints
  • Added design docs for INTROSPECTION-PARITY and AGENT-ERGONOMICS
  • Added AI onboarding guide - docs/how-to/ai-first-hour.md for agent first-contact
  • Selftest passes all 11 governance checks

Kernel Governance

  • 72 kernel ACs (must_have_ac=true) - all passing or explicitly meta/CI-only
  • 133 total ACs with full traceability (US → REQ → AC → tests → docs)
  • 11-step selftest validation gate
  • IDP integration surfaces - /platform/* APIs documented

IDP Integration

Surface Status
/platform/status ✅ Governance health & AC coverage
/platform/agent/hints ✅ Prioritized work suggestions
/platform/graph ✅ Full governance graph
cargo xtask idp-snapshot ✅ Machine-readable tile

Documentation

Release Evidence

  • release_evidence/v3.3.8.md - 19 completed tasks, AC delta, governance status
  • release_evidence/kernel_contract.v3.3.8.json - 34 commands, 15 platform endpoints

For Forks

To adopt this kernel version:
```bash
git fetch upstream
git checkout v3.3.8-kernel
nix develop
cargo xtask dev-up
cargo xtask selftest
```

See docs/how-to/adopt-kernel.md for detailed adoption guidance.

Rust-as-Spec Kernel v3.3.7

09 Dec 07:41

Choose a tag to compare

Rust-as-Spec Kernel v3.3.7

This tag freezes the kernel template for the Rust-as-Spec platform cell.

The kernel is the part of this repo that defines what "good" looks like:

  • Stories, requirements, and acceptance criteria (specs/spec_ledger.yaml)
  • BDD features and test mappings (specs/features/*.feature)
  • Governance graph + introspection surfaces (/platform/*, /ui)
  • xtask contracts and selftest gates

In v3.3.7 the kernel is:

  • ✅ 65/65 kernel ACs passing (must_have_ac: true)
  • ✅ Strict AC coverage enforced in CI (XTASK_STRICT_AC_COVERAGE=1)
  • ✅ 11/11 selftest steps green

Evidence

Machine- and human-readable evidence for this kernel:

  • AC status dashboard
    docs/feature_status.md
    Auto-generated via:

    cargo xtask ac-status
  • Kernel contract (machine-readable)
    release_evidence/kernel_contract.v3.3.7.json
    Describes xtask commands, /platform/* endpoints, and governance schemas for this version.

  • Release evidence (human-readable)
    release_evidence/v3.3.7.md
    Summarises what changed, which ACs/REQs/ADRs are affected, and the selftest state.

  • Kernel snapshot
    docs/KERNEL_SNAPSHOT.md
    High-level description of what a fork inherits at this tag.


Intended use

This tag is meant to be used as a kernel baseline:

  1. Start from the tag:

    git clone https://github.com/EffortlessMetrics/Rust-Template.git my-service
    cd my-service
    git checkout v3.3.7-kernel
  2. Enter the dev shell and validate:

    nix develop
    cargo xtask dev-up
    cargo xtask selftest
  3. Change identity for your service:

    cargo xtask service-init \
      --id my-service \
      --name "My Service" \
      --description "What this service does" \
      --tags demo example
  4. Re-run:

    cargo xtask selftest

From here you add your stories/REQs/ACs and domain crates. The kernel contracts
(existing AC-TPL-* / AC-PLT-* with must_have_ac: true) should not be weakened
without:

  • An ADR in docs/adr/,
  • Updated specs/BDD/tests,
  • And a new kernel tag (e.g. v3.3.8-kernel) with fresh evidence.

Adoption Guide

See docs/how-to/adopt-kernel.md for step-by-step instructions.


Compatibility

  • Rust: see rust-toolchain.toml
  • Environment: Tier-1 is Nix dev shell (nix develop); native Windows is Tier-2
  • CI: expect cargo xtask selftest as the main required check

v3.3.6-kernel

05 Dec 02:32

Choose a tag to compare

Rust-as-Spec kernel v3.3.6 (IDP-ready)

Kernel features:
- Platform APIs: /platform/status, /platform/docs/index, /platform/schema
- OpenAPI spec with 500 error responses
- TypeScript configuration governance
- Backstage plugin reference consumer in examples/backstage-plugin
- 61 kernel ACs passing (selftest green)

v2.3.1 - Bootstrap Cleanup and Documentation Refinement

19 Nov 21:29

Choose a tag to compare

v2.3.1 - Bootstrap Cleanup and Documentation Refinement

Release Date: 2025-11-19
Status: Production-ready template for governed Rust services

This patch release removes the shell-based pilot scaffolding script and replaces it with clear, explicit documentation for template instantiation. All automation now lives in Rust (xtask), Rego (policies), or Nix (dev environment)—no ad-hoc shell tooling.


🔧 Changed

Bootstrap Process:

  • Removed scripts/create-pilot.sh - replaced with documented GitHub template workflow
  • Updated all documentation with explicit bootstrap instructions:
    • Option 1: GitHub "Use this template" (recommended)
    • Option 2: Manual git clone with documented commands
  • Rationale: Template instantiation should be transparent and leverage GitHub's first-class features, not hidden in opaque shell scripts

Documentation Updates:

  • README.md: Updated "Pilot Workflow" with both bootstrap paths
  • CLAUDE.md: Updated LLM prompts to reference new workflow
  • docs/README.md: Added complete git commands for both options
  • CHANGELOG.md: Documented removal rationale

📊 What's in v2.3.x

This template provides production-ready governance for Rust services:

  • Spec-as-Code: AC ledger + BDD scenarios validated by xtask selftest
  • Policy-as-Code: 22 OPA/Rego tests enforcing ledger structure, feature coverage, K8s standards
  • Design-as-Code: ADRs tracked in ledger, validated in CI
  • Nix-First Dev: Pinned toolchain matching CI exactly (cargo, rustc, conftest, yq)
  • LLM-Assisted Workflow: Bounded context bundles via .llm/contextpack.yaml
  • Hexagonal Architecture: Clean ports/adapters separation (HTTP, gRPC, business core)
  • Single Quality Gate: xtask selftest runs fmt, clippy, tests, BDD, AC validation, policies

🎯 For Platform/DevEx Engineers

If you're evaluating this template:

  1. Quick validation:
    ```bash

    Use GitHub "Use this template" or clone manually

    git clone https://github.com/EffortlessMetrics/Rust-Template.git my-service
    cd my-service
    nix develop
    cargo run -p xtask -- selftest # All 5 steps pass
    ```

  2. Real-world pilot:

    • Add 2-3 ACs to specs/spec_ledger.yaml
    • Implement features following CLAUDE.md workflow
    • Track friction in FRICTION_LOG.md
    • Validate: does the governance help or hinder?
  3. Key principle:

    "Everything important is code and validated: business logic in Rust, policies in Rego, infrastructure in Nix, design decisions in ADRs."


📚 Documentation


🔄 Upgrading from v2.3.0

No breaking changes. If you previously used `scripts/create-pilot.sh`, simply follow the new documented paths in `README.md` → "Pilot Workflow."


🙏 Feedback Welcome

This template is designed for real usage validation. If you pilot it:

  • Log friction in `FRICTION_LOG.md`
  • Open issues for blockers
  • Share what worked / what didn't

The roadmap for v2.4.0+ will be informed by pilot friction logs, not feature speculation.


Full Changelog: `v2.3.0...v2.3.1`