From 5752488ef114513c8f75d753cf91d5b61dfa0660 Mon Sep 17 00:00:00 2001
From: Levente Polyak <anthraxx@archlinux.org>
Date: Sat, 17 Dec 2022 01:51:15 +0100
Subject: release: command to commit, tag and upload build artifacts

This is a smart and more convenient invocation of the classical
commitpkg and archrelease with auto-discovery for target repositories
and a shorthand option to directly call db-update.
---
 doc/man/pkgctl-release.1.asciidoc | 49 +++++++++++++++++++++++++++++++++++++++
 doc/man/pkgctl.1.asciidoc         |  4 ++++
 2 files changed, 53 insertions(+)
 create mode 100644 doc/man/pkgctl-release.1.asciidoc

(limited to 'doc')

diff --git a/doc/man/pkgctl-release.1.asciidoc b/doc/man/pkgctl-release.1.asciidoc
new file mode 100644
index 0000000..c991db4
--- /dev/null
+++ b/doc/man/pkgctl-release.1.asciidoc
@@ -0,0 +1,49 @@
+pkgctl-release(1)
+=================
+
+Name
+----
+pkgctl-release - Release step to commit, tag and upload build artifacts
+
+Synopsis
+--------
+pkgctl release [OPTIONS] [PATH...]
+
+Description
+-----------
+
+Modified version controlled files will first be staged for commit,
+afterwards a Git tag matching the pkgver will be created and finally
+all build artifacts will be uploaded.
+
+By default the target pacman repository will be auto-detected by querying
+the repo it is currently released in. When initially adding a new package
+to the repositories, the target repo must be specified manually.
+
+Options
+-------
+
+*-m, --message* 'MSG'::
+	Use the given <msg> as the commit message
+
+*-r, --repo* 'REPO'::
+	Specify a target repository (disables auto-detection)
+
+*-s, --staging*::
+	Build against the staging counterpart of the auto-detected repo
+
+*-t, --testing*::
+	Build against the testing counterpart of the auto-detected repo
+
+*-u, --db-update*::
+	Automatically update the pacman database after uploading
+
+*-h, --help*::
+	Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-db-update[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 93fed5b..8da5d19 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -26,6 +26,9 @@ pkgctl db::
 pkgctl diff::
 	Compare package files using different modes
 
+pkgctl release::
+	Release step to commit, tag and upload build artifacts
+
 pkgctl repo::
 	Manage Git packaging repositories and their configuration
 
@@ -35,6 +38,7 @@ See Also
 linkman:pkgctl-auth[1]
 linkman:pkgctl-db[1]
 linkman:pkgctl-diff[1]
+linkman:pkgctl-release[1]
 linkman:pkgctl-repo[1]
 
 include::include/footer.asciidoc[]
-- 
cgit v1.2.3-70-g09d2