search

pulsar-edit / ppm

Pulsar Package Manager
MIT License
35 stars 13 forks source link

src: Fix usage/help text (and error message) for -b/-t flags for ppm install #105

Closed DeeDeeG closed 8 months ago

DeeDeeG commented 8 months ago

These flags do not actually take commit SHAs as arguments, only branch or tag names.

The flags are aliases of one-another and work the exact same -- either flag can take a branch name or tag name. No SHAs.

Optional context: Issue report https://github.com/pulsar-edit/pulsar/issues/821 over at the core repo brought this back to my attention, although I believe it had been brought up somewhere in Discord a long time ago, just now getting around to finally updating the usage/help text to be accurate.

DeeDeeG commented 8 months ago

macOS CI failure is unrelated, it's the "old node-gyp, new Python" issues again.

I have to review how we worked around these things in CI for other repos. Wanted to get this PR out quickly, will have to come back around to fixing CI here soon.

EDIT: I am okay with delaying PRs such as this until CI is fixed, if folks prefer. We know how to work around these issues from experience at our other repos, so it just takes a quick look at that "prior art" and copy-pasting whatever workarounds seem the most palatable from there to here.

Daeraxa commented 8 months ago

Just to add for posterity's sake, the docs look correct here: https://pulsar-edit.dev/docs/launch-manual/sections/using-pulsar/#command-line

It doesn't say a commit hash can be used:

pulsar -p install <git_remote> [-b <branch_or_tag>]