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.3
+V=1.0.4
 BUILDTOOLVER ?= $(V)
 
 PREFIX = /usr/local

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

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'

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() {
@@ -177,13 +178,11 @@ done
 # check for PKGBUILD standards
 check_pkgbuild_validity
 
-# auto generate .SRCINFO if present
-if [[ -f .SRCINFO ]]; then
+# auto generate .SRCINFO
 stat_busy 'Generating .SRCINFO'
-	makepkg --printsrcinfo > .SRCINFO
-	git add .SRCINFO
+write_srcinfo_content > .SRCINFO
+git add --force .SRCINFO
 stat_done
-fi
 
 if [[ -n $(git status --porcelain --untracked-files=no) ]]; then
 	stat_busy 'Staging files'

src/lib/build/build.sh

@@ -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
 				;;

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
@@ -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/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