Skip to content

docs(install): document local clone+link flow and CI install smoke - #14

Open
Munawarx wants to merge 1 commit into
Nazim22:mainfrom
Munawarx:docs/npm-install-and-publish
Open

docs(install): document local clone+link flow and CI install smoke#14
Munawarx wants to merge 1 commit into
Nazim22:mainfrom
Munawarx:docs/npm-install-and-publish

Conversation

@Munawarx

Copy link
Copy Markdown
Contributor

Summary

Makes Leadline installable without the npx github: specifier. package.json is private: true, so an npm package isn't publishable yet; this adds a documented local install path plus a CI job that proves it.

Changes

  • README "Get started": add a git clone && npm install && npm link flow so the leadline command is available from a current checkout, and a note that the npm package is still on the roadmap. Document the Node ≥ 18 requirement and the Linux-only exam harness caveat.
  • .github/workflows/ci.yml: add an install-smoke job (ubuntu-latest, Node 20) that runs npm cinpm link → invokes the leadline CLI, proving the documented install path works on a clean runner.

Why

Contributors on non-Linux hosts (and anyone who wants a pinned local copy) had only the GitHub-specifier install. A reproducible local install lowers the contribution barrier and is the interim step before a published npm package.

Verification

  • README change is docs-only; CI adds a job that exercises npm link + the CLI.
  • No engine / contract-engine / schema / security-boundary changes — docs/infra per CONTRIBUTING.

Trade-offs

  • Keeps private: true (no published package yet) — the clone+link path is the supported interim. When the maintainer is ready to publish, flipping private: false + adding prepare/version tagging is the follow-up.

Files

  • README.md
  • .github/workflows/ci.yml

Co-Authored-By: Hermes Agent noreply@hermes.ai

The only install path was 'npx github:Nazim22/leadline'; package.json is
private so npm publish is not yet available. Add a documented local-install
flow (git clone + npm install + npm link) and a CI 'install-smoke' job that
proves the CLI links and runs. Also notes Node >=18 and the Linux-only exam
harness caveat. Docs/infra only; no engine/contract changes.

Co-Authored-By: Hermes Agent <noreply@hermes.ai>
@Munawarx

Copy link
Copy Markdown
Contributor Author

Tracking our current contribution set for Leadline (Munawarx). All are independent, each on its own branch:

Each PR is self-contained and ready to review independently. Happy to split, adjust, or rebase any of them. Co-Authored-By: Hermes Agent noreply@hermes.ai

@Nazim22 Nazim22 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified: two blockers. (1) The documented "dry-run" flow actually writes 7 files (settings.json hooks, .leadline/config.yaml + packs) — that's upstream bug #18, being fixed; these docs should land AFTER so they document the corrected behavior. (2) The CI smoke leadline --help || leadline init --claude-code --dry-run short-circuits — --help exits 0 so the init path is never exercised. Deferring until #18 ships; a rebase then would be welcome.

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.

2 participants