Support for skupper

[fgiorgetti]

Describe the feature/solution

We'd like to request support for skupper (https://skupper.io/ - repo: https://github.com/skupperproject/skupper/).
I believe it just needs to be linked to _golangci-lint as it already offers the completion bash support (provided by Cobra).

Maintenance (please complete the following information)

• This is a request for new completion
• Link to upstream project query about shipping the completion:

http://skupper.io - repository.

[akinomyoga]

• Link to upstream project query about shipping the completion:

http://skupper.io - repository.

This is not "a link to the upstream project query about shipping the completion". This is just a link to the top page of the project. See also lines 7-8 of CONTRIBING.md.

I believe it just needs to be linked to _golangci-lint as it already offers the completion bash support (provided by Cobra).

Nevertheless, this type of completion setting can be included in bash-completion as a third-party fallback completion.

[fgiorgetti]

@akinomyoga The skupper command already supports bash completion, through skupper completion bash, as other commands in this repository do, like cmctl. I am not sure what specific link I should provide, but I would be glad to add it if you provide me a sample.

I see that the repository has some entries associating commands to golangci-lint through completions-fallback/Makefile.am, but I am not sure if that is enough to get a PR pushed or if some sort of approval is needed first.

Please let me know what I can do next.

Thanks.

[akinomyoga]

The skupper command already supports bash completion, through skupper completion bash

No, the support by skupper is incomplete. That's the reason you request something here. If the support by the skupper command were complete, we wouldn't have to do anything at the bash-completion side, so we could close this issue immediately.

More specifically, the bash-completion framework is designed so that an upstream project can install a completion file to enable completion without changing bash-completion. The upstream project should consider installing a completion file or providing their own way of loading the settings. We host in bash-completion only completion files for Bash built-in commands and keywords, completion files for commands that are specific to or dependent on operating systems, completion files for commands whose upstream refused to include them, and fallback completion files.

I am not sure what specific link I should provide, but I would be glad to add it if you provide me a sample.

You should be able to guess it from CONTRIBUTING.md. You were supposed to ask the upstream first about installing a completion file as part of its installation. When the upstream is not interested in shipping the completion file with it, you can come to bash-completion and say "please include a completion file in bash-completion because the upstream refused it".

We request a reference showing that the upstream refused to include the completion file, or at least, we request a reference showing that you've already contacted the upstream project.

as other commands in this repository do, like cmctl.

Those are "fallback". We can actually include a fallback completion loader in bash-completion, but we should still reach out to the upstream whether they can include a completion file.

Please let me know what I can do next.

Ask the upstream.

[yedayak]

To be more specific, what's needed for it to work out of the box is for the install script (which seems to be the recommended way to install the tool) to also generate the completion and put it in the correct location (~/.local/share/bash-completion/completions/skupper.bash if it's a user installation).

We can consider also supporting it as a fallback completion, but I think we should let the upstream project do the correct thing first.

[fgiorgetti]

Thank you @yedayak and @akinomyoga. Actually I am one of the maintainers of the Skupper project and the reason why I raised this question was because I downloaded the cert-manager CLI cmctl (just the binary) and I noticed that the bash completion was working for it.

Then I have found out that the fallback script (_golangci-lint) was handling it, as _cmctl was linked to it.

Most of our upstream users consume just the skupper binary from our released files and we do not have any current plan to change the installation procedure or to maintain upstream packages.

There are productized distributions of Skupper, which provide RPM packages for installing the CLI, and those packages could certainly do that.

But if you guys could add a similar link, it would help our existing upstream users, as all versions of our skupper cli already support the completion bash command (as in /usr/share/bash-completion/completions/_golangci-lint).

I appreciate your attention and thank you again.

[scop]

Most of our upstream users consume just the skupper binary from our released files

This is true for a lot of tools these days, and because we install the "generator" as fallbacks anyway, I feel we can be more relaxed with regards to the "ask upstream project" ask for these cases.

So I have no objection against just adding the 3rd party fallback symlink for skupper the usual way.

While this mechanism is pretty easy, it's static in nature, meaning it depends on users updating their bash-completion (release or git checkout) to get the new completions we add explicit symlink support for.

[akinomyoga]

Thank you for the explanation. Let me emphasize that I don't have an objection to having the third-party fallback completion in bash-completion. This is the third time that I've written this, but we can include the third-party fallback completion for skupper.

One of the reasons that we recommend the upstream to offer the completion file is to cover the case that skupper switches the underlying completion library (or library version) that leads to an interface change. One might think it will never happen for a specific command, but I think there have been a few cases out of hundreds of commands in the market. In that sense, the upstream doesn't need to offer the completion file for now; technically, the upstream can start to offer the completion loader only when it first changes the command-line interface to output the completion settings.

Most of our upstream users consume just the skupper binary from our released files

I'm not sure if the "Most" is specifically true for skupper. As long as I can search the web, the primary install method seems to be curl https://skupper.io/install.sh | sh -s -- --version <version>, where install.sh can arrange the completion file at ~/.local/share/bash-completion/completions/skupper.bash. Windows users seem to be forced to do the manual installation, which just downloads the binary file. Even in that case, you can add a subsection under the Installing manually section to explain the completion setting.

[fgiorgetti]

I'm not sure if the "Most" is specifically true for skupper. As long as I can search the web, the primary install method seems to be curl https://skupper.io/install.sh | sh -s -- --version <version>, where install.sh can arrange the completion file at ~/.local/share/bash-completion/completions/skupper.bash. Windows users seem to be forced to do the manual installation, which just downloads the binary file. Even in that case, you can add a subsection under the Installing manually section to explain the completion setting.

That is true! We can also accommodate it as part of this particular installation process. But anyway, having it included here, would help existing users. We will also make that change. Thank you.