From 77d800eab2419b334cafd94b2e986351919def77 Mon Sep 17 00:00:00 2001
From: Levente Polyak <anthraxx@archlinux.org>
Date: Sun, 23 Oct 2022 20:42:34 +0200
Subject: auth: implemented module to authenticate against our GitLab

This helps to have a convenient way to manage and test our personal
GitLab tokens. Those are used for certain API calls like creating new
repositories.

prefill the access token web view as per
https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#prefill-personal-access-token-name-and-scopes

Signed-off-by: Levente Polyak <anthraxx@archlinux.org>
---
 doc/man/pkgctl-auth-login.1.asciidoc  | 33 ++++++++++++++++++++++++++++++
 doc/man/pkgctl-auth-status.1.asciidoc | 32 +++++++++++++++++++++++++++++
 doc/man/pkgctl-auth.1.asciidoc        | 38 +++++++++++++++++++++++++++++++++++
 doc/man/pkgctl.1.asciidoc             |  4 ++++
 4 files changed, 107 insertions(+)
 create mode 100644 doc/man/pkgctl-auth-login.1.asciidoc
 create mode 100644 doc/man/pkgctl-auth-status.1.asciidoc
 create mode 100644 doc/man/pkgctl-auth.1.asciidoc

(limited to 'doc/man')

diff --git a/doc/man/pkgctl-auth-login.1.asciidoc b/doc/man/pkgctl-auth-login.1.asciidoc
new file mode 100644
index 0000000..9c32ab2
--- /dev/null
+++ b/doc/man/pkgctl-auth-login.1.asciidoc
@@ -0,0 +1,33 @@
+pkgctl-auth-login(1)
+====================
+
+Name
+----
+pkgctl-auth-login - Authenticate with the GitLab instance
+
+Synopsis
+--------
+pkgctl auth login [OPTIONS]
+
+Description
+-----------
+
+Interactively authenticate with the GitLab instance.
+
+The minimum required scopes for the token are: 'api', 'write_repository'.
+
+Options
+-------
+
+*-g, --gen-access-token*::
+	Open the URL to generate a new personal access token
+
+*-h, --help*::
+	Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-auth-status[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-auth-status.1.asciidoc b/doc/man/pkgctl-auth-status.1.asciidoc
new file mode 100644
index 0000000..e23ee2e
--- /dev/null
+++ b/doc/man/pkgctl-auth-status.1.asciidoc
@@ -0,0 +1,32 @@
+pkgctl-auth-status(1)
+=====================
+
+Name
+----
+pkgctl-auth-status - View authentication status
+
+Synopsis
+--------
+pkgctl auth status [OPTIONS]
+
+Description
+-----------
+
+Verifies and displays information about your authentication state of
+services like the GitLab instance and reports issues if any.
+
+Options
+-------
+
+*-t, --show-token*::
+	Display the auth token
+
+*-h, --help*::
+	Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-auth-login[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl-auth.1.asciidoc b/doc/man/pkgctl-auth.1.asciidoc
new file mode 100644
index 0000000..4912b02
--- /dev/null
+++ b/doc/man/pkgctl-auth.1.asciidoc
@@ -0,0 +1,38 @@
+pkgctl-auth(1)
+==============
+
+Name
+----
+pkgctl-auth - Authenticate with serivces like GitLab.
+
+Synopsis
+--------
+pkgctl auth [OPTIONS] [SUBCOMMAND]
+
+Description
+-----------
+
+Manage the authorization for the GitLab instance and show its current status.
+
+Options
+-------
+
+*-h, --help*::
+	Show a help text
+
+Subcommands
+-----------
+
+pkgctl auth login::
+	Authenticate with the GitLab instance
+
+pkgctl auth status::
+	View authentication status
+
+See Also
+--------
+
+linkman:pkgctl-auth-login[1]
+linkman:pkgctl-auth-status[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 0455074..45d5187 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -17,6 +17,9 @@ TODO
 Subcommands
 -----------
 
+pkgctl auth::
+	Authenticate with services like GitLab
+
 pkgctl diff::
 	Compare package files using different modes
 
@@ -26,6 +29,7 @@ pkgctl repo::
 See Also
 --------
 
+linkman:pkgctl-auth[1]
 linkman:pkgctl-diff[1]
 linkman:pkgctl-repo[1]
 
-- 
cgit v1.2.3-70-g09d2