From a37aad32c1f2e34c19634b5b2f3ce311971c7da6 Mon Sep 17 00:00:00 2001
From: Ioannis Bonatakis <ybonatakis@suse.com>
Date: Thu, 21 Nov 2024 16:00:32 +0100
Subject: [PATCH] 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 <ybonatakis@suse.com>
---
 .../openqa-cli-completion.bash                |  0
 .../openqa-cli-completion.zsh                 |  0
 dist/rpm/openQA.spec                          | 20 +++++++++++++++++++
 docs/UsersGuide.asciidoc                      | 10 +++-------
 4 files changed, 23 insertions(+), 7 deletions(-)
 rename openqa-cli-completion.bash => completion/openqa-cli-completion.bash (100%)
 rename openqa-cli-completion.zsh => completion/openqa-cli-completion.zsh (100%)

diff --git a/openqa-cli-completion.bash b/completion/openqa-cli-completion.bash
similarity index 100%
rename from openqa-cli-completion.bash
rename to completion/openqa-cli-completion.bash
diff --git a/openqa-cli-completion.zsh b/completion/openqa-cli-completion.zsh
similarity index 100%
rename from openqa-cli-completion.zsh
rename to completion/openqa-cli-completion.zsh
diff --git a/dist/rpm/openQA.spec b/dist/rpm/openQA.spec
index 1af37ecb2c51..0242b17cc123 100644
--- a/dist/rpm/openQA.spec
+++ b/dist/rpm/openQA.spec
@@ -314,6 +314,21 @@ 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}
+Supplements:    (%{name}-client and zsh)
+
+%description client-zsh-completion
+The official zsh completion script for openqa-cli.
 
 %prep
 %setup -q
@@ -419,6 +434,8 @@ done
 #
 install -D -m 644 /dev/null %{buildroot}%{_localstatedir}/log/openqa
 install -m 0644 %{_sourcedir}/openQA.changes %{buildroot}%{_datadir}/openqa/public/Changelog
+install -Dm 0644 completion/openqa-cli-completion.bash %{buildroot}%{_datadir}/bash-completion/completions/openqa-cli
+install -Dm 0644 completion/openqa-cli-completion.zsh %{buildroot}%{_datadir}/usr/share/zsh/site-functions/_openqa-cli
 #
 mkdir %{buildroot}%{_localstatedir}/lib/openqa/pool/1
 mkdir %{buildroot}%{_localstatedir}/lib/openqa/cache
@@ -769,6 +786,9 @@ fi
 %{_bindir}/openqa-load-templates
 %{_bindir}/openqa-clone-custom-git-refspec
 %{_bindir}/openqa-validate-yaml
+%dir %{_datadir}/openqa/completion
+%{_datadir}/openqa/completion/openqa-cli-completion.bash
+%{_datadir}/openqa/completion/openqa-cli-completion.zsh
 
 %if %{with python_scripts}
 %files python-scripts
diff --git a/docs/UsersGuide.asciidoc b/docs/UsersGuide.asciidoc
index 50389e19a221..f5934dd29269 100644
--- 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