Skip to content

Docs + CI for the cargo install path - #180

Merged
Endle merged 1 commit into
masterfrom
ci-cargo-install
Jul 24, 2026
Merged

Endle merged 1 commit into
masterfrom
ci-cargo-install

Conversation

@Endle

@Endle Endle commented Jul 24, 2026

Copy link
Copy Markdown
Owner

fire_seq_search_server 1.0.1 is on crates.io now, so cargo install is the primary way to get the server. Two changes follow from that.

README

Section 2 leads with cargo install fire_seq_search_server and notes that it lands on PATH in ~/.cargo/bin (plus a heads-up that the first install compiles bundled SQLite, so it takes a few minutes). The Logseq/Obsidian examples drop their ./target/release/ prefix.

Build-from-source moves to a #### Building from source instead subsection rather than being deleted — it's still the development path.

fire_seq_search_server/README.md (the crates.io landing page) already had this right from #177 and is untouched.

New Install workflow

Verifies the install path end to end on ubuntu-latest and macos-14: package, install, then run the binary as a bare command to prove PATH placement and startup.

Two decisions worth review:

  • Installs from the extracted package tarball, not cargo install --path .. --path ignores Cargo.toml's exclude, so it would happily build against files that never ship to crates.io. Now that tests/, *.sh, and deny.toml are excluded, that's exactly the class of breakage this job exists to catch. The version is read via cargo metadata + jq, so it needs no bumping.
  • Master + workflow_dispatch only, not PRs. It's a release-profile build with a bundled SQLite compiled from C — minutes, not seconds — and ci.yml already gates every PR with cargo test on three platforms plus a verifying cargo package. --no-verify on the package step here since the install recompiles the same tree anyway.

Verified locally (macOS)

  • cargo package --locked --no-verify → 28 files, 286.4 KiB
  • installed from the extracted tarball into a throwaway --root → clean release build
  • fire_seq_search_server --version → fire_seq_search_server 1.0.1, exit 0

Note this workflow tests the source tree's installability, not the published registry artifact — installing from crates.io on a master push would only re-test whatever is already published. A post-publish registry check would be a separate scheduled job.

🤖 Generated with Claude Code

fire_seq_search_server 1.0.1 is on crates.io now, so `cargo install` is the
primary way to get the server and the README should lead with it. The
build-from-source instructions move to a subsection rather than disappearing —
they're still the development path.

Add an Install workflow that verifies the install path end to end on Linux and
macOS. It installs from the *extracted package tarball* rather than
`cargo install --path .`: `--path` ignores Cargo.toml's `exclude`, so it would
build against files that never ship to crates.io, which is precisely the
breakage worth catching now that `tests/` and `*.sh` are excluded.

Master + manual only — it's a release build with a bundled SQLite compiled from
C, and ci.yml's cargo test + cargo package already gate every PR.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Endle
Endle merged commit f9f9793 into master Jul 24, 2026
10 checks passed
@Endle
Endle deleted the ci-cargo-install branch July 24, 2026 21:01
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