chore(release): version v1.0.4

Anything that requires user input (such as a key unlock or hostkey
verify) will block the terminal and wait for input which will never
come.

When cloning or configuring a repo via ssh we therefore initially
connect to gitlab to warm the connection.

Afterwards users are expected to either have setup a ssh ControlMaster
or use something like a ssh agent.

Fixes #148

Component: pkgctl repo clone/configure

Co-Authored-by: Christian Heusel <christian@heusel.eu>
Signed-off-by: Christian Heusel <christian@heusel.eu>
Signed-off-by: Levente Polyak <anthraxx@archlinux.org>

Makefile

@@ -1,6 +1,6 @@
 SHELL=/bin/bash
 
-V=1.0.1
+V=1.0.4
 BUILDTOOLVER ?= $(V)
 
 PREFIX = /usr/local
@@ -145,19 +145,20 @@ uninstall:
 		$(DESTDIR)$(DATADIR)/pacman.conf.d \
 		$(DESTDIR)$(DATADIR)
 
-TODAY=$(shell date +"%Y%m%d")
 tag:
-	@sed -E "s|^V=[0-9]{8}|V=$(TODAY)|" -i Makefile
-	@git commit --gpg-sign --message "Version $(TODAY)" Makefile
-	@git tag --sign --message "Version $(TODAY)" $(TODAY)
+	@echo "current version: v$(V)"
+	@read -r -p "tag version: v" VERSION && \
+	sed -E "s|^V=.+|V=$$VERSION|" -i Makefile && \
+	git commit --gpg-sign --message "chore(release): version v$$VERSION" Makefile && \
+	git tag --sign --message "Version v$$VERSION" v$$VERSION
+
+release: dist
+	glab release create v$(V) devtools-$(V).tar.gz*
 
 dist:
-	git archive --format=tar --prefix=devtools-$(V)/ $(V) | gzip > devtools-$(V).tar.gz
+	git archive --format=tar --prefix=devtools-$(V)/ v$(V) | gzip > devtools-$(V).tar.gz
 	gpg --detach-sign --use-agent devtools-$(V).tar.gz
 
-upload:
-	scp devtools-$(V).tar.gz devtools-$(V).tar.gz.sig repos.archlinux.org:/srv/ftp/other/devtools/
-
 check: $(BINPROGS_SRC) $(LIBRARY_SRC) contrib/completion/bash/devtools.in config/makepkg/x86_64.conf contrib/makepkg/PKGBUILD.proto
 	shellcheck $^
 

README.md

@@ -23,6 +23,34 @@ will automatically build the project and proxy all calls to the local build dire
 ./test/bin/pkgctl --help
 ```
 
+### Commit messages
+
+All commits must follow [conventional commits](https://www.conventionalcommits.org).
+
+The following groups are allowed:
+
+- chore
+- feat
+- fix
+- doc
+- perf
+- test
+
+To override the scope for the changelog entry use the `Component:` trailer.
+
+Example:
+
+```
+feat(db): yay mega cool feature
+
+Very long and useful description.
+
+Fixes #1
+Fixes #2
+
+Component: pkgctl db remove
+```
+
 ## Releasing
 
 1. bump the version in the Makefile
@@ -42,6 +70,7 @@ will automatically build the project and proxy all calls to the local build dire
 - binutils
 - coreutils
 - diffutils
+- fakeroot
 - findutils
 - grep
 - jq

cliff.toml

@@ -0,0 +1,44 @@
+[changelog]
+header = "# Changelog\n\n"
+body = """
+{%- if version -%}
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{%- else -%}
+    ## [unreleased]
+{%- endif %}
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits | sort(attribute="message") %}
+		- {% set component = commit.footers | filter(attribute="token", value="Component") | map(attribute="value") | join %}
+		{%- if component %}{{ component }}: {% elif commit.scope %}{{ commit.scope }}: {% endif %}
+		{{- commit.message | upper_first }}
+		{%- set fixes = commit.footers | filter(attribute="token", value="Fixes") %}
+		{%- for fix in fixes %}{{ fix.separator }}{{ fix.value }}{% endfor %}
+    {%- endfor %}
+{% endfor %}
+
+"""
+footer = ""
+
+# remove the leading and trailing whitespaces from the template
+trim = true
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^chore\\(release\\): version", skip = true},
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "*v[0-9]*"

config/makepkg/x86_64.conf

@@ -25,7 +25,7 @@ DLAGENTS=('file::/usr/bin/curl -qgC - -o %o %u'
 
 #-- The package required by makepkg to download VCS sources
 #  Format: 'protocol::package'
-VCSCLIENTS=('bzr::bzr'
+VCSCLIENTS=('bzr::breezy'
             'fossil::fossil'
             'git::git'
             'hg::mercurial'

config/makepkg/x86_64_v3.conf

@@ -25,7 +25,7 @@ DLAGENTS=('file::/usr/bin/curl -qgC - -o %o %u'
 
 #-- The package required by makepkg to download VCS sources
 #  Format: 'protocol::package'
-VCSCLIENTS=('bzr::bzr'
+VCSCLIENTS=('bzr::breezy'
             'fossil::fossil'
             'git::git'
             'hg::mercurial'

contrib/completion/zsh/_devtools.in

@@ -241,7 +241,7 @@ _pkgctl_cmds=(
 	"pkgctl command"
 	"auth[Authenticate with services like GitLab]"
 	"build[Build packages inside a clean chroot]"
-	"db[Pacman database modification for packge update, move etc]"
+	"db[Pacman database modification for package update, move etc]"
 	"diff[Compare package files using different modes]"
 	"release[Release step to commit, tag and upload build artifacts]"
 	"repo[Manage Git packaging repositories and their configuration]"

doc/man/pkgctl.1.asciidoc

@@ -33,7 +33,7 @@ pkgctl build::
 	Build packages inside a clean chroot
 
 pkgctl db::
-	Pacman database modification for packge update, move etc
+	Pacman database modification for package update, move etc
 
 pkgctl diff::
 	Compare package files using different modes

src/arch-nspawn.in

@@ -16,7 +16,6 @@ umask 0022
 working_dir=''
 
 files=()
-mount_args=()
 
 usage() {
 	echo "Usage: ${0##*/} [options] working-dir [systemd-nspawn arguments]"
@@ -32,6 +31,9 @@ usage() {
 	exit 1
 }
 
+# save all args for check_root
+orig_args=("$@")
+
 while getopts 'hC:M:c:f:s' arg; do
 	case "$arg" in
 		C) pac_conf="$OPTARG" ;;
@@ -46,13 +48,23 @@ done
 shift $((OPTIND - 1))
 
 (( $# < 1 )) && die 'You must specify a directory.'
-check_root "" "${BASH_SOURCE[0]}" "$@"
+check_root "" "${BASH_SOURCE[0]}" "${orig_args[@]}"
 
 working_dir=$(readlink -f "$1")
 shift 1
 
 [[ -z $working_dir ]] && die 'Please specify a working directory.'
 
+nspawn_args=(
+	--quiet
+	--directory="$working_dir"
+	--setenv="PATH=/usr/local/sbin:/usr/local/bin:/usr/bin"
+	--register=no
+	--slice="devtools-$(systemd-escape "${SUDO_USER:-$USER}")"
+	--machine="arch-nspawn-$$"
+	--as-pid2
+)
+
 if (( ${#cache_dirs[@]} == 0 )); then
 	mapfile -t cache_dirs < <(pacman-conf --config "${pac_conf:-$working_dir/etc/pacman.conf}" CacheDir)
 fi
@@ -80,10 +92,10 @@ while read -r line; do
 	done
 done < <(pacman-conf --config "${pac_conf:-$working_dir/etc/pacman.conf}" --repo-list)
 
-mount_args+=("--bind=${cache_dirs[0]//:/\\:}")
+nspawn_args+=(--bind="${cache_dirs[0]//:/\\:}")
 
 for cache_dir in "${cache_dirs[@]:1}"; do
-	mount_args+=("--bind-ro=${cache_dir//:/\\:}")
+	nspawn_args+=(--bind-ro="${cache_dir//:/\\:}")
 done
 
 # {{{ functions
@@ -126,9 +138,4 @@ else
 	set_arch="${CARCH}"
 fi
 
-exec ${CARCH:+setarch "$set_arch"} systemd-nspawn -q \
-	-D "$working_dir" \
-	-E "PATH=/usr/local/sbin:/usr/local/bin:/usr/bin" \
-	--register=no --keep-unit --as-pid2 \
-	"${mount_args[@]}" \
-	"$@"
+exec ${CARCH:+setarch "$set_arch"} systemd-nspawn "${nspawn_args[@]}" "$@"

src/commitpkg.in

@@ -7,6 +7,7 @@ _DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
 source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
 
 source /usr/share/makepkg/util/util.sh
+source /usr/share/makepkg/srcinfo.sh
 
 
 check_pkgbuild_validity() {
@@ -111,7 +112,7 @@ if (( ${#validpgpkeys[@]} != 0 )); then
 fi
 
 # find files which should be under source control
-needsversioning=()
+needsversioning=(PKGBUILD)
 for s in "${source[@]}"; do
 	[[ $s != *://* ]] && needsversioning+=("$s")
 done
@@ -129,6 +130,10 @@ done
 # assert that they really are controlled by git
 if (( ${#needsversioning[*]} )); then
 	for file in "${needsversioning[@]}"; do
+		# skip none existing files
+		if [[ ! -f "${file}" ]]; then
+			continue
+		fi
 		if ! git ls-files --error-unmatch "$file"; then
 			die "%s is not under version control" "$file"
 		fi
@@ -173,13 +178,11 @@ done
 # check for PKGBUILD standards
 check_pkgbuild_validity
 
-# auto generate .SRCINFO if present
-if [[ -f .SRCINFO ]]; then
-	stat_busy 'Generating .SRCINFO'
-	makepkg --printsrcinfo > .SRCINFO
-	git add .SRCINFO
-	stat_done
-fi
+# auto generate .SRCINFO
+stat_busy 'Generating .SRCINFO'
+write_srcinfo_content > .SRCINFO
+git add --force .SRCINFO
+stat_done
 
 if [[ -n $(git status --porcelain --untracked-files=no) ]]; then
 	stat_busy 'Staging files'

src/lib/build/build.sh

@@ -129,7 +129,7 @@ pkgctl_build() {
 	local WORKER_SLOT=
 
 	# variables
-	local path pkgbase pkgrepo source
+	local loop_arch path pkgbase pkgrepo source
 
 	while (( $# )); do
 		case $1 in
@@ -200,7 +200,7 @@ pkgctl_build() {
 				;;
 			-I|--install)
 				(( $# <= 1 )) && die "missing argument for %s" "$1"
-				MAKECHROOT_OPTIONS+=("-I" "$2")
+				MAKECHROOT_OPTIONS+=("-I" "$(realpath "$2")")
 				warning 'installing packages into the chroot may break reproducible builds, use with caution!'
 				shift 2
 				;;
@@ -298,7 +298,7 @@ pkgctl_build() {
 				die 'failed to get pacman repo'
 			fi
 			if [[ -z "${pkgrepo}" ]]; then
-				die 'unknown repo, please specify --repo for new packages'
+				die 'unknown repo, specify --repo for packages not currently in any official repo'
 			fi
 		fi
 
@@ -318,7 +318,13 @@ pkgctl_build() {
 			if in_array any "${arch[@]}"; then
 				BUILD_ARCH=("${_arch[0]}")
 			else
-				BUILD_ARCH+=("${arch[@]}")
+				for loop_arch in "${arch[@]}"; do 
+					if in_array "${loop_arch}" "${_arch[@]}"; then
+						BUILD_ARCH+=("$loop_arch")
+					else
+						warning 'invalid architecture, not building for: %s' "${loop_arch}"
+					fi
+				done
 			fi
 		fi
 
@@ -329,7 +335,7 @@ pkgctl_build() {
 
 		# increment pkgrel on rebuild
 		if (( REBUILD )); then
-			# try to figure out of pkgrel has been changed
+			# try to figure out if pkgrel has been changed
 			if ! old_pkgrel=$(git_diff_tree HEAD PKGBUILD | grep --perl-regexp --only-matching --max-count=1 '^-pkgrel=\K\w+'); then
 				old_pkgrel=${pkgrel}
 			fi

src/lib/db.sh

@@ -15,7 +15,7 @@ pkgctl_db_usage() {
 	cat <<- _EOF_
 		Usage: ${COMMAND} [COMMAND] [OPTIONS]
 
-		Pacman database modification for packge update, move etc
+		Pacman database modification for package update, move etc
 
 		COMMANDS
 		    move      Move packages between pacman repositories

src/lib/repo/clone.sh

@@ -12,6 +12,8 @@ source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
 source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
 # shellcheck source=src/lib/repo/configure.sh
 source "${_DEVTOOLS_LIBRARY_DIR}"/lib/repo/configure.sh
+# shellcheck source=src/lib/util/git.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/util/git.sh
 
 source /usr/share/makepkg/util/message.sh
 
@@ -52,6 +54,7 @@ pkgctl_repo_clone() {
 	fi
 
 	# options
+	local protocol=ssh
 	local GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_SSH}
 	local CLONE_ALL=0
 	local MAINTAINER=
@@ -72,6 +75,7 @@ pkgctl_repo_clone() {
 				;;
 			--protocol=https)
 				GIT_REPO_BASE_URL=${GIT_PACKAGING_URL_HTTPS}
+				protocol=https
 				CONFIGURE_OPTIONS+=("$1")
 				shift
 				;;
@@ -82,6 +86,7 @@ pkgctl_repo_clone() {
 				else
 					die "unsupported protocol: %s" "$2"
 				fi
+				protocol="$2"
 				CONFIGURE_OPTIONS+=("$1" "$2")
 				shift 2
 				;;
@@ -171,6 +176,12 @@ pkgctl_repo_clone() {
 		if [[ -n "${VERSION}" ]]; then
 			command+=" --switch '${VERSION}'"
 		fi
+
+		# warm up ssh connection as it may require user input (key unlock, hostkey verification etc)
+		if [[ ${protocol} == ssh ]]; then
+			git_warmup_ssh_connection
+		fi
+
 		if ! parallel --bar --jobs "${jobs}" "${command}" ::: "${pkgbases[@]}"; then
 			die 'Failed to clone some packages, please check the output'
 			exit 1

src/lib/repo/configure.sh

@@ -10,6 +10,8 @@ _DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
 source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
 # shellcheck source=src/lib/api/gitlab.sh
 source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
+# shellcheck source=src/lib/util/git.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/util/git.sh
 
 source /usr/share/makepkg/util/config.sh
 source /usr/share/makepkg/util/message.sh
@@ -38,7 +40,7 @@ pkgctl_repo_configure_usage() {
 		    -h, --help           Show this help text
 
 		EXAMPLES
-		    $ ${COMMAND} configure *
+		    $ ${COMMAND} *
 _EOF_
 }
 
@@ -188,6 +190,12 @@ pkgctl_repo_configure() {
 		if [[ -n ${BOLD} ]]; then
 			export DEVTOOLS_COLOR=always
 		fi
+
+		# warm up ssh connection as it may require user input (key unlock, hostkey verification etc)
+		if [[ ${proto} == ssh ]]; then
+			git_warmup_ssh_connection
+		fi
+
 		if ! parallel --bar --jobs "${jobs}" "${command}" ::: "${paths[@]}"; then
 			die 'Failed to configure some packages, please check the output'
 			exit 1

src/lib/repo/web.sh

@@ -26,7 +26,7 @@ pkgctl_repo_web_usage() {
 		    -h, --help    Show this help text
 
 		EXAMPLES
-		    $ ${COMMAND} web linux
+		    $ ${COMMAND} linux
 _EOF_
 }
 

src/lib/util/git.sh

@@ -7,6 +7,9 @@ DEVTOOLS_INCLUDE_UTIL_GIT_SH=1
 
 _DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
 
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+
 
 git_diff_tree() {
 	local commit=$1
@@ -22,3 +25,10 @@ git_diff_tree() {
 		"${commit}" \
 		-- "${path}"
 }
+
+git_warmup_ssh_connection() {
+	msg 'Establishing ssh connection to git@%s' "${GITLAB_HOST}"
+	if ! ssh -T "git@${GITLAB_HOST}" >/dev/null; then
+		die 'Failed to establish ssh connection to git@%s' "${GITLAB_HOST}"
+	fi
+}

src/lib/util/pacman.sh

@@ -39,12 +39,15 @@ get_pacman_repo_from_pkgbuild() {
 	fi
 
 	slock 10 "${_DEVTOOLS_PACMAN_CACHE_DIR}.lock" "Locking pacman database cache"
+	# query repo of passed pkgname, specify --nodeps twice to skip all dependency checks
 	mapfile -t repos < <(pacman --config "${_DEVTOOLS_PACMAN_CONF_DIR}/multilib.conf" \
 		--dbpath "${_DEVTOOLS_PACMAN_CACHE_DIR}" \
-		-S \
+		--sync \
+		--nodeps \
+		--nodeps \
 		--print \
 		--print-format '%n %r' \
-		"${pkgnames[0]}" | grep -E "^${pkgnames[0]} " | awk '{print $2}'
+		"${pkgnames[0]}" | awk '$1=="'"${pkgnames[0]}"'"{print $2}'
 	)
 	lock_close 10
 

src/makerepropkg.in

@@ -125,6 +125,9 @@ OPTIONS
 __EOF__
 }
 
+# save all args for check_root
+orig_args=("$@")
+
 while getopts 'dM:c:l:h' arg; do
     case "$arg" in
         d) diffoscope=1 ;;
@@ -137,7 +140,7 @@ while getopts 'dM:c:l:h' arg; do
 done
 shift $((OPTIND - 1))
 
-check_root "" "${BASH_SOURCE[0]}" "$@"
+check_root "" "${BASH_SOURCE[0]}" "${orig_args[@]}"
 
 [[ -f PKGBUILD ]] || { error "No PKGBUILD in current directory."; exit 1; }
 

src/mkarchroot.in

@@ -32,6 +32,9 @@ usage() {
 	exit 1
 }
 
+# save all args for check_root
+orig_args=("$@")
+
 while getopts 'hUC:M:c:f:s' arg; do
 	case "$arg" in
 		U) umode=U ;;
@@ -52,7 +55,7 @@ shift $((OPTIND - 1))
 
 (( $# < 2 )) && die 'You must specify a directory and one or more packages.'
 
-check_root "" "${BASH_SOURCE[0]}" "$@"
+check_root "" "${BASH_SOURCE[0]}" "${orig_args[@]}"
 
 working_dir="$(readlink -f "$1")"
 shift 1

src/pkgctl.in

@@ -21,7 +21,7 @@ usage() {
 		COMMANDS
 		    auth    Authenticate with services like GitLab
 		    build   Build packages inside a clean chroot
-		    db      Pacman database modification for packge update, move etc
+		    db      Pacman database modification for package update, move etc
 		    diff    Compare package files using different modes
 		    release Release step to commit, tag and upload build artifacts
 		    repo    Manage Git packaging repositories and their configuration