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

Fix Bash completions #1721

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pdietl
Copy link

@pdietl pdietl commented Jul 20, 2024

Fix Bash completions
The previous completion script was including extra completions that were not actually commands.
This commit also moves the completion file and renames it such that on Ubuntu one can simple download the release zip, unpack it, cd into the unpacked directory, and run cp -r bin share /usr/local/ to install with bash-completions in the proper place to get automatically sourced

@pdietl pdietl force-pushed the pdietl/fix_bash_completions branch from ae6d09e to 7e6e412 Compare July 20, 2024 02:12
The previous completion script was including extra completions that
were not actually commands.

This commit also moves the completion file and renames it such that
on Ubuntu one can simple download the release zip, unpack it, cd
into the unpacked directory, and run `cp -r bin share /usr/local`
to install with bash-completions in the proper place to get
automatically sourced
@pdietl pdietl force-pushed the pdietl/fix_bash_completions branch from 7e6e412 to 37f82d5 Compare July 20, 2024 02:50
@@ -66,7 +66,9 @@ jobs:

- name: Package binaries
if: (github.event_name == 'release')
run: zip alr-bin-linux.zip bin/alr LICENSE.txt
run: |
echo 'sudo cp -r bin share /usr/local/' > INSTALL.md
Copy link
Member

Choose a reason for hiding this comment

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

I'd rather have a proper INSTALL.md file a bit more fleshed out, where this command is not just given but also explained. Some people may prefer to use another prefix not requiring sudo.

Copy link
Author

Choose a reason for hiding this comment

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

Should I make this Linux-specific or even distro specific? I believe that where to put Bash completion files is a bit distro-dependent.

Copy link
Member

Choose a reason for hiding this comment

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

Can this be found automatically? Otherwise I don't think we want to manually maintain such a thing. We can explain in the INSTALL.md file that the given structure is for Debian and should be tweaked if needed. Also yes, I think the INSTALL.md should make clear this is only for Unix-like, and that there's a Windows installer.

share/bash-completion/completions/alr Outdated Show resolved Hide resolved
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