Skip to content

docs(ci): document auto bm dogfood install#890

Merged
phernandez merged 1 commit into
mainfrom
codex/auto-bm-merge-test
Jun 5, 2026
Merged

docs(ci): document auto bm dogfood install#890
phernandez merged 1 commit into
mainfrom
codex/auto-bm-merge-test

Conversation

@phernandez
Copy link
Copy Markdown
Member

Documents the temporary checkout install used while dogfooding Auto BM before the next package release. This merged PR is also the live Auto BM publish-path smoke test.

Signed-off-by: phernandez <paul@basicmachines.co>
@phernandez phernandez merged commit 0adbc12 into main Jun 5, 2026
18 of 24 checks passed
@phernandez phernandez deleted the codex/auto-bm-merge-test branch June 5, 2026 01:44
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

Claude finished @phernandez's task in 1m 20s —— View job


PR Review

  • Gather context and understand the PR
  • Read changed file(s)
  • Review against team checklist
  • Post final review summary

This is a documentation-only change to src/basic_memory/ci/README.md. The PR adds a paragraph (3 net lines) explaining the temporary checkout install pattern used when dogfooding an unreleased bm ci change, plus a note that the live repository workflow may temporarily use a checked-out install during that period.

Checklist Results

Code Quality & Standards

  • Follows Basic Memory coding conventions — prose is concise and on-brand
  • No commented-out code blocks — documentation only

Testing & Documentation

  • Documentation updated — this IS the documentation change; content is accurate and well-placed in the Setup CI/CD section
  • No test coverage concerns — no code changed
  • CLAUDE.md update not required — no convention changes

Basic Memory Architecture

  • Preserves local-first architecture principles — documentation only

Security & Performance

  • No hardcoded secrets or credentials
  • No sensitive data in logs or commits
  • No emojis or problematic unicode in the added content

Observations

The added paragraph sits naturally at the end of the Setup CI/CD section, right before the post-setup verification steps. The two-sentence structure works well:

  1. General guidance for any consumer dogfooding an unreleased bm ci change
  2. A repo-specific note explaining why the live workflow may look different from the documented PyPI install path

This is a low-risk, well-scoped documentation change. No issues found.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant