| #!/bin/bash | |
| # SPDX-License-Identifier: MPL-2.0 | |
| # release.sh: configurable signed-artefact release script | |
| # Copyright (C) 2016-2025 SUSE LLC | |
| # Copyright (C) 2026 Aleksa Sarai <cyphar@cyphar.com> | |
| # | |
| # This Source Code Form is subject to the terms of the Mozilla Public | |
| # License, v2.0. If a copy of the MPL was not distributed with this | |
| # file, You can obtain one at http://mozilla.org/MPL/2.0/. | |
| set -Eeuo pipefail | |
| # shellcheck source=./readlinkf.sh | |
| source "$(dirname "${BASH_SOURCE[0]}")/readlinkf.sh" | |
| ## ---> | |
| # Project-specific options and functions. In *theory* you shouldn't need to | |
| # touch anything else in this script in order to use this elsewhere. | |
| project="libpathrs" | |
| root="$(readlinkf_posix "$(dirname "${BASH_SOURCE[0]}")/..")" | |
| # These functions allow you to configure how the defaults are computed. | |
| function get_host_target() { rustc --print host-tuple ; } | |
| function get_version() { cargo metadata --format-version=1 | jq -rM '.packages[] | select(.name == "pathrs") | .version' ; } | |
| # Any pre-configuration steps should be done here -- for instance ./configure. | |
| function setup_project() { true ; } | |
| # This function takes an output path as an argument, where the built | |
| # (preferably static) binary should be placed. | |
| function build_project() { | |
| # TODO: Figure out what we should do for builds... | |
| true | |
| } | |
| # Generates a vendor.tar.zstd file to "$1" (set to "-" to get it to stdout). | |
| function generate_vendor() { | |
| local vendor_tar="$1" | |
| local tmpvendor | |
| tmpvendor="$(mktemp -dt "$project-vendor.XXXXXX")" | |
| # shellcheck disable=SC2064 # We want to expand the variables immediately. | |
| trap "rm -rf '$tmpvendor'" RETURN | |
| cargo vendor --versioned-dirs "$tmpvendor/vendor" | |
| tar cv -f "$vendor_tar" -C "$tmpvendor/" vendor/ | |
| } | |
| # End of the easy-to-configure portion. | |
| ## <--- | |
| # Print usage information. | |
| function usage() { | |
| echo "usage: release.sh [-h] [-v <version>] [-c <commit>] [-o <output-dir>]" >&2 | |
| echo " [-H <hashcmd>] [-S <gpg-key>]" >&2 | |
| } | |
| # Log something to stderr. | |
| function log() { | |
| echo "[*]" "$@" >&2 | |
| } | |
| # Log something to stderr and then exit with 0. | |
| function quit() { | |
| log "$@" | |
| exit 0 | |
| } | |
| # Conduct a sanity-check to make sure that GPG provided with the given | |
| # arguments can sign something. Inability to sign things is not a fatal error. | |
| function gpg_cansign() { | |
| gpg "$@" --clear-sign </dev/null >/dev/null | |
| } | |
| # When creating releases we need to build (ideally static) binaries, an archive | |
| # of the current commit, and generate detached signatures for both. | |
| keyid="" | |
| version="" | |
| commit="HEAD" | |
| hashcmd="sha256sum" | |
| while getopts ":c:H:h:o:S:v:" opt; do | |
| case "$opt" in | |
| c) | |
| commit="$OPTARG" | |
| ;; | |
| H) | |
| hashcmd="$OPTARG" | |
| ;; | |
| h) | |
| usage ; exit 0 | |
| ;; | |
| o) | |
| outputdir="$OPTARG" | |
| ;; | |
| S) | |
| keyid="$OPTARG" | |
| ;; | |
| v) | |
| version="$OPTARG" | |
| ;; | |
| :) | |
| echo "Missing argument: -$OPTARG" >&2 | |
| usage ; exit 1 | |
| ;; | |
| \?) | |
| echo "Invalid option: -$OPTARG" >&2 | |
| usage ; exit 1 | |
| ;; | |
| esac | |
| done | |
| # Run project setup first... | |
| ( set -x ; setup_project ) | |
| # Generate the defaults for version and so on *after* argument parsing and | |
| # setup_project, to avoid calling get_version() needlessly. | |
| version="${version:-$(get_version)}" | |
| outputdir="${outputdir:-release/$version}" | |
| log "[[ $project ]]" | |
| log "version: $version" | |
| log "commit: $commit" | |
| log "output_dir: $outputdir" | |
| log "key: ${keyid:-(default)}" | |
| log "hash_cmd: $hashcmd" | |
| # Make explicit what we're doing. | |
| set -x | |
| # Make the release directory. | |
| rm -rf "$outputdir" && mkdir -p "$outputdir" | |
| # Build project. | |
| # TODO: Figure out what we should do for builds... | |
| #for target in "${targets[@]}"; do | |
| # target="${target//\//.}" | |
| # os="$(cut -d. -f1 <<<"$target")" | |
| # arch="$(cut -d. -f2 <<<"$target")" | |
| # GOOS="$os" GOARCH="$arch" build_project "$outputdir/$project.$target" | |
| #done | |
| # Generate vendor.tar.zst. | |
| generate_vendor "$outputdir/$project.vendor.tar" | |
| zstd -11 --rm "$outputdir/$project.vendor.tar" -o "$outputdir/$project.vendor.tar.zst" | |
| # Generate new archive. | |
| git archive --format=tar --prefix="$project-$version/" "$commit" | xz > "$outputdir/$project-$version.tar.xz" | |
| # Generate sha256 checksums for everything. | |
| ( cd "$outputdir" ; "$hashcmd" "$project"* > "$project.$hashcmd" ; ) | |
| # Set up the gpgflags. | |
| gpgflags=() | |
| [[ -z "$keyid" ]] || gpgflags+=("--default-key=$keyid") | |
| gpg_cansign "${gpgflags[@]}" || quit "Could not find suitable GPG key, skipping signing step." | |
| # Make explicit what we're doing. | |
| set -x | |
| # Check that the keyid is actually in the $project.keyring by signing a piece | |
| # of dummy text then verifying it against the list of keys in that keyring. | |
| tmp_gpgdir="$(mktemp -d --tmpdir "$project-sign-tmpkeyring.XXXXXX")" | |
| trap 'rm -r "$tmp_gpgdir"' EXIT | |
| tmp_project_gpgflags=("--homedir=$tmp_gpgdir" "--no-default-keyring" "--keyring=$project.keyring") | |
| gpg "${tmp_project_gpgflags[@]}" --import <"$root/$project.keyring" | |
| gpg "${gpgflags[@]}" --clear-sign <<<"[This is test text used for $project release scripts. $(date --rfc-email)]" | | |
| gpg "${tmp_project_gpgflags[@]}" --verify || bail "Signing key ${keyid:-DEFAULT} is not in trusted $project.keyring list!" | |
| # Make sure the signer is okay with the list of keys in the keyring (once this | |
| # release is signed, distributions will trust this keyring). | |
| cat >&2 <<EOF | |
| == PLEASE VERIFY THE FOLLOWING KEYS == | |
| The sources for this release will contain the following signing keys as | |
| "trusted", meaning that distributions may trust the keys to sign future | |
| releases. Please make sure that only authorised users' keys are listed. | |
| $(gpg "${tmp_project_gpgflags[@]}" --list-keys) | |
| [ Press ENTER to continue. ] | |
| EOF | |
| read -r | |
| # Sign everything from our project. | |
| for file in "$outputdir/$project"*; do | |
| [[ "$file" == */$project.$hashcmd ]] && continue # inline clear-signed | |
| gpg "${gpgflags[@]}" --detach-sign --armor "$file" | |
| done | |
| gpg "${gpgflags[@]}" --clear-sign --armor \ | |
| --output "$outputdir/$project.$hashcmd"{.tmp,} && \ | |
| mv "$outputdir/$project.$hashcmd"{.tmp,} |