Skip to content

feat: npm publish readiness — version, update-check, install scripts (#286–#289)#292

Open
flyingrobots wants to merge 8 commits intomainfrom
feat/npm-publish-readiness
Open

feat: npm publish readiness — version, update-check, install scripts (#286–#289)#292
flyingrobots wants to merge 8 commits intomainfrom
feat/npm-publish-readiness

Conversation

@flyingrobots
Copy link
Owner

@flyingrobots flyingrobots commented Feb 24, 2026

Summary

Problem Statement

Package is not publishable to npm — missing files whitelist, publishConfig, version export, install scripts, and correct package name. Users cannot install via npm or run update checks.

ADR Compliance (Required)

Relevant ADR(s)

  • None

Compliance Declaration

  • This PR is fully compliant with all checked ADRs.

Architecture Laws Checklist (Hard Gates)

Canonical Truth & Context

  • Graph remains canonical truth (no dual truth with generated files).
  • No hidden worktree coupling introduced in core/domain/materialization paths.
  • Context-sensitive behavior is explicit (--at, --observer, --trust) or deterministically defaulted.
  • Resolved context is surfaced in output metadata where applicable.

Determinism & Provenance

  • Pure query/materialization paths remain deterministic for identical inputs.
  • Mutations/materializations include provenance receipts/envelopes where required.
  • Cache keys (if used) are derived only from semantic inputs + pinned versions.

Artifact Hygiene

  • No forbidden generated artifact paths are tracked.
  • Any generated artifacts intentionally tracked are in allowlisted publish paths only.
  • Pre-commit/CI policy checks updated or confirmed valid.

Contracts & Compatibility

  • Machine-facing outputs are schema-versioned.
  • Breaking contract changes include version bump + migration notes.
  • Backward compatibility impact is documented below.

Extension/Effects Safety (if applicable)

  • Extension behavior does not bypass capability restrictions.
  • Effectful operations use explicit plan/apply semantics and emit receipts.
  • Timeouts/resource bounds are defined for new script/effect paths.

Scope Control

  • PR is single-purpose/cohesive (no unrelated refactors).
  • Any non-essential refactor is split into separate PR(s) or explicitly justified.

Backward Compatibility

  • CLI/API contract changes: Added --version flag (additive). Package renamed from @neuroglyph/git-mind to @flyingrobots/git-mind (breaking for existing installs).
  • Data model/storage changes: None
  • Migration required?: Users must npm install @flyingrobots/git-mind instead of old package name
  • User-facing behavior changes: --version flag prints version and exits. Update-check notification on CLI startup.

Test Plan (Required)

Unit

  • Added/updated tests for changed logic
  • Commands:
npm test -- test/version.test.js test/update-check.test.js

Integration

  • Added/updated integration tests
  • Commands:
# Docker-isolated integration test runner
docker build -f test/Dockerfile -t git-mind-test .

Determinism

  • Determinism assertions included for relevant paths
  • Method: Update-check uses deterministic cache key derivation
  • Commands:
npm test

Contract/Schema

  • Schema validation updated/passing
  • Commands:
npm run lint

Policy Gates

  • Mechanical architecture gates pass
  • Commands:
npm test && npm run lint

Security / Trust Impact

  • Threat surface changed?: Update-check fetches from npm registry (network call, bounded by Alfred timeout/retry policy)
  • Trust policy impact: None
  • Provenance/audit impact: None
  • New failure modes introduced: Network timeout on update check (gracefully handled, non-blocking)

Performance Impact

  • Hot path affected?: No — update check is async and non-blocking on CLI startup
  • Expected impact (latency/memory/io): Minimal — single HTTP fetch with 3s timeout, cached for 24h
  • Benchmarks or profiling evidence: N/A

Observability / Debuggability

  • Errors are actionable and include context.
  • Logs/diagnostics added or updated where needed.
  • git mind status / diagnostics updated if writeback/eventing behavior changed.

Operational Notes

  • Feature flag (if any): None
  • Rollback strategy: Revert commits
  • Operational caveats: ANTHROPIC_API_KEY not needed for this PR

Linked Issues / Milestones


Reviewer Quick Verdict Block (for maintainers)

MUST (Hard Gates)

•	PASS
•	CONDITIONAL
•	FAIL

SHOULD (Quality)

•	PASS
•	CONDITIONAL
•	FAIL

Verdict

•	APPROVE
•	APPROVE WITH CHANGES
•	REJECT

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant