docs(readme): document mise install path#573
Conversation
Zious11
left a comment
There was a problem hiding this comment.
Thanks @arcaven — this is a genuinely useful addition and the section slots in exactly the right place. The mise mechanics you describe check out (we verified the github: backend behavior, prerelease = true, and the native attestation verification against mise's docs). Two accuracy items need a copy edit before merge, plus a few smaller suggestions.
Required
1. The attestation sentence conflates mise-side support with repo-side publishing.
mise's native verification is already shipped — what's pending is this repo publishing attestations (that's #574, not yet merged). Also, automatic verification for a plain github: install covers GitHub Artifact Attestations; "SLSA provenance" overstates what runs by default. As written, readers may think a chain-of-trust story exists today. Suggested rewrite:
mise's `github:` backend auto-selects the release asset matching your OS
and architecture and extracts the `jr` binary. Once releases ship GitHub
Artifact Attestations (planned — see #574), mise verifies them natively
without invoking `gh` or `slsa-verifier`.
(Alternatively: drop the paragraph for now and re-add it when #574 lands.)
2. Make the canonical example runnable.
The rest of the Install section uses concrete strings (Zious11/jira-cli in the curl one-liner, git clone, tap). A literal <owner> in the fenced block means copy-paste fails and the reader has to backtrack. Suggested:
mise use github:Zious11/jira-cli@latestwith a single follow-up sentence: "Replace Zious11 with a fork's owner if you install from a downstream distribution." (Same for the mise.toml snippet.)
Recommended
3. The prerelease glob lists v*-beta.* / v*-rc.*, but this repo has only ever cut -dev.* prereleases. Suggest narrowing to v*-dev.* (or hedge with "if cut").
4. Windows gotcha worth one line: the current stable (v0.5.0) shipped without a Windows asset, so Windows users need prerelease = true until v0.6.0 stable — otherwise @latest resolves to a release with no matching asset.
5. "extracts the jr binary onto your PATH" assumes mise activate is set up — a "(assumes mise activate in your shell profile)" parenthetical or a link to mise's Getting Started would prevent "installed but jr not found" reports.
Optional
6. xattr -d com.apple.quarantine "$(mise which jr)" — in the exact failure mode this addresses, mise which jr may print nothing (mise not yet active in that shell) and the command errors confusingly. Consider showing the raw install path form as a fallback.
Happy to merge once 1–2 are addressed. Appreciate the fork-transparency framing and the tested claims — the smoke-test detail in the description made this easy to review.
…sted (SHA pins verified; TOCTOU/fork-gate/CWE-77 findings); review artifacts committed
- Fix the attestation sentence: mise's native verification already ships; what is pending is this repo publishing attestations (Zious11#574). Drop the 'SLSA provenance runs by default' overstatement. - Make the mise use / mise.toml examples runnable (Zious11/jira-cli), with one fork-owner substitution sentence. - Narrow the prerelease glob to the only channel this repo cuts (v*-dev.*). - Note mise activate is assumed for the binary to land on PATH. - Add the Windows-has-no-stable-asset-yet caveat (needs prerelease=true). - Give an activation-free xattr fallback via 'mise where'.
…-PR triage (D-178) - BC-3.5.006 SATISFIED: spec v1.3.42 (bc-3-issue-write.md); EJ probe confirmed green by nightly run 29398774009 (test_e2e_comment_edit_visibility_merge_semantics ok on develop @ 56d5126); CHANGELOG MERGE-claim now empirically backed. - Docs PR #625 (docs/577-ej-probe-closeout) CI 14/14 green; HELD for human review+merge (independent-review guard — classifier blocked pr-manager and orchestrator reviewer dispatch; session authored the PR; SELF-APPROVAL-GUARD 2nd positive datapoint). - Fresh PR reviews: #573 APPROVE @ 046ee4f (pr-review-2.md); #574 code review APPROVE-pending-rebase + security review APPROVE @ 3c37948 (pr-review-2.md + security-review-2.md; CHANGELOG-only conflict needs contributor rebase). - PR triage: #591 MERGE-READY (9-day soak); #598/#599 HOLD-SOAK-2026-07-16; #612 HOLD-SOAK-2026-07-20; #624 HOLD-SOAK-2026-07-22. - DEC-178: all-dependabot soak broadened to ALL dependabot PRs (cargo + Actions), not just third-party Actions bumps (broadens DEC-133). - Drift items: FACTORY-DISPATCHER-HOOK-TIMEOUT (engine-side, LOW); SELF-APPROVAL-GUARD-2ND-DATAPOINT (positive control, CLOSED). - STATE.md: 341 lines (cap 500); burst-log.md: F5-CONVERGED + F4-COMPLETE step rows archived per keep-5 rule; sidecar-learning.md session timestamps added.
|
Thanks for the careful read — pushed Required
Recommended
Optional
|
Summary
Adds a short "Install with mise" section to the Install part of the README,
documenting
mise use github:<owner>/jira-cli@latestas an alternative tothe curl-piped one-liner. Owner-agnostic — the same snippet works for this
repository and any fork that publishes its own signed releases.
Why
mise use github:<owner>/jira-cliworks today with zero additionalpublisher work: mise's
github:backend auto-picks the correct tarballfrom the release asset set and extracts the
jrbinary ontoPATH.Smoke-tested end-to-end on macOS arm64 against
v0.5.0(
jr-v0.5.0-aarch64-apple-darwin.tar.gz→jr 0.5.0).one-liner installer. Users on the mise/asdf/pyenv side of the ecosystem
get a familiar install without needing a Homebrew tap.
prerelease = trueopt-in for tracking-dev.*/-beta.*/-rc.*releases cut fromdevelop, matching the existing gitflowchannels.
line for
xattr -d com.apple.quarantine(needed only when aquarantine-aware host process propagates the attribute — mise itself
does not set it, mirroring Homebrew bottles).
What this is not
to
jdx/miseand is out of scope here).Cargo.toml,src/, or CI touched.Fork-transparency
The snippet uses
<owner>as a placeholder with an explanatory sentence,so the block is correct whether a reader is looking at this repository
or at a downstream fork's checkout. No hardcoded owner in the mise text
(unchanged elsewhere: the existing curl one-liner, badges, and
"Coming soon" tap URLs still reference the canonical owner as they did
before).
Test plan
mise installunder amise.tomlpinninggithub:Zious11/jira-cli = "0.5.0"— resolves the darwin arm64 tarball, extractsjr,jr --versionreportsjr 0.5.0.prerelease = trueresolves against the latestv*-dev.*tag (currentlyv0.6.0-dev.7).