Create openqa-cli-bash-completion package

Provide openqa-cli bash completion for openqa-cli as a package when openQA is install and bash is used. Signed-off-by: Ioannis Bonatakis <[email protected]>
os-autoinst · Nov 22, 2024 · f75305f · f75305f
1 parent 298cf29
commit f75305f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 7 deletions.
diff --git a/dist/rpm/openQA.spec b/dist/rpm/openQA.spec
@@ -314,6 +314,22 @@ Use this package to install munin scripts that allow to monitor some openQA
 statistics.
 %endif
 
+%package client-bash-completion
+Summary:        Bash Completion for %{name}
+Requires:       bash-completion
+Supplements:    (%{name}-client and bash)
+
+%description client-bash-completion
+The official bash completion script for openqa-cli.
+
+
+%package client-zsh-completion
+Summary:        Zsh Completion for %{name}
+Requires:       bash-completion
+Supplements:    (%{name}-client and zsh)
+
+%description client-zsh-completion
+The official zsh completion script for openqa-cli.
 
 %prep
 %setup -q

diff --git a/docs/UsersGuide.asciidoc b/docs/UsersGuide.asciidoc
@@ -963,13 +963,9 @@ without needing to install openQA itself. Call `openqa-cli --help` for help.
 The sub-commands provide further help, e.g. `openqa-cli api --help` contains
 a lot of examples.
 
-`openqa-cli` supports auto completion for `bash` and `zsh`.
-If you use `bash` run or add the line below on your `.bashrc` profile.
-
-[source,sh]
-----
-source openqa-cli-completion.bash
-----
+`openqa-cli` supports auto completion for `bash` and `zsh`. We distribute two
+packages `openQA-client-bash-completion` and `openQA-client-zsh-completion` as
+part of openQA-client.
 
 This section focuses on particular API use-cases. Checkout the
 <<Client.asciidoc#client,openQA client>> section for further information about