Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3 binaries after install instead of one #1043

Open
adriangalilea opened this issue Apr 17, 2024 · 4 comments
Open

3 binaries after install instead of one #1043

adriangalilea opened this issue Apr 17, 2024 · 4 comments
Milestone

Comments

@adriangalilea
Copy link

Hello,

I've noticed that after install I get 3 binaries

ls /Library/Frameworks/Python.framework/Versions/3.11/bin | grep bugwarrior

bugwarrior-pull
bugwarrior-uda
bugwarrior-vault

This seems to contradict the documentation, I tried installing from pip and from source just to see if there was something wrong with one of the installing methods.

Is this to be expected?

I'm on macOS.

@ryneeverett
Copy link
Collaborator

This seems to contradict the documentation

I have a feeling this is another case of #1007. I'm guessing you're looking at the Command Line Interface page of the "latest" documentation but are installing the "stable" 1.8.0 release.

For context, the top-level bugwarrior command with subcommands has not yet been released. As of right now the top-level command is added as a fourth binary. The original three binaries are still shipped but are no longer documented. I was originally planning to ship the next release with all 4 binaries but now that it's determined the next release will be a major release it's probably best to go ahead and drop them.

@ryneeverett ryneeverett added this to the release-next milestone Apr 17, 2024
@adriangalilea
Copy link
Author

You are absolutely correct @ryneeverett However if I set "stable" on the documentation it gives a 404 :)

No worries, I'll continue using the 3 commands for now.

@ryneeverett
Copy link
Collaborator

However if I set "stable" on the documentation it gives a 404 :)

Yes, I ran into that myself and it is most annoying. I believe it only happens when you're on a page that didn't exist in the "stable" documentation.

@adriangalilea
Copy link
Author

adriangalilea commented Apr 17, 2024

However if I set "stable" on the documentation it gives a 404 :)

Yes, I ran into that myself and it is most annoying. I believe it only happens when you're on a page that didn't exist in the "stable" documentation.

Got it, perhaps a banner on top of the dev docs would suffice in the meantime, with a link to the relevant docs :)

WARNING: you are navigating the dev docs, but you probably installed 1.8 go here to see the docs for your version.

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

No branches or pull requests

2 participants