There are scripts which we use over and over again in different projects. As they might be usable for you as well, we are publishing them here. Feel free to use it and report bugs if you should find one.
âť— You are taking a sneak peek at the next version. It could be that some features you find on this page are not
released yet.
Please have a look at the README of the corresponding release/git tag. Latest
version: README of v4.2.0.
Table of Content
We recommend you pull the scripts with the help of gt.
Alternatively you can
Following the commands you need to execute to set up tegonal scripts via gt.
gt remote add -r tegonal-scripts -u https://github.com/tegonal/scriptsNow you can pull the scripts you want via:
export TEGONAL_SCRIPTS_VERSION="v4.2.0"
gt pull -r tegonal-scripts -t "$TEGONAL_SCRIPTS_VERSION" -p ...Note that dependencies have to be pulled manually and almost all scripts depend on src/setup.sh
which in turn depends on src/utility/source-once.sh and this one depends on src/utility/log.sh.
Many of the scripts depend on further scripts located in src/utility.
Therefore, for simplicity reasons, we recommend you pull src/setup.sh and all files in src/utility in addition:
export TEGONAL_SCRIPTS_VERSION="v4.2.0"
gt pull -r tegonal-scripts -t "$TEGONAL_SCRIPTS_VERSION" -p src/setup.sh
gt pull -r tegonal-scripts -t "$TEGONAL_SCRIPTS_VERSION" -p src/utility/
We recommend you use the following code at the beginning of your script in case you want to source a file/function
(in the example below we want to use tegonal's io functions located in utility/io.sh):
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
if ! [[ -v dir_of_tegonal_scripts ]]; then
# Assumes your script is in (root is project folder) e.g. /src or /scripts and
# the tegonal scripts have been pulled via gt and put into /lib/tegonal-scripts
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
fi
sourceOnce "$dir_of_tegonal_scripts/utility/io.sh"Note that source "$dir_of_tegonal_scripts/setup.sh" will automatically source utility/source-once.sh
and utility/log.sh
The scripts are ordered by topic:
-
- Releasing Files
- Prepare Files Next Dev Cycle
- Release Template
- Prepare Next Dev Cycle Template
- git Pre-Release checks
- sbt sonatype publish
- Update Version common steps
- Update Version in README
- Update Version in bash scripts
- Update Version in issue templates
- Toggle main/release sections
- Hide/Show sneak-peek banner
- Create tag, prepare-next, push
The scripts under this topic (in directory ci) help out in performing CI steps.
Installs shellcheck. Most likely, you want to use it together with runShellcheck. Following an example:
# run the install-shellcheck.sh in your github/gitlab workflow
# for instance, assuming you fetched this file via gt and remote name is tegonal-scripts
# then in a github workflow you would have
jobs:
steps:
- name: install shellcheck
run: ./lib/tegonal-scripts/src/ci/install-shellcheck.sh
# and most likely as well
- name: run shellcheck
run: ./scripts/run-shellcheck.sh# run the install-shellcheck.sh in your github/gitlab workflow
# for instance, assuming you fetched this file via gt and remote name is tegonal-scripts
# then in a github workflow you would have
jobs:
steps:
- name: install shellspec
run: ./lib/tegonal-scripts/src/ci/install-shellspec.sh
# and most likely as well
- name: run shellspec
run: shellspecThe scripts under this topic (in directory ci/jelastic) help out when dealing with jelastic cli
Helper function which performs a signin and redeploycontainers
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
# typically you would define those via secrets (GitHub) or Variables (Gitlab)
JELASTIC_LOGIN='my-user'
JELASTIC_PASSWORD='access-token'
JELASTIC_PLATFORM_URL='https://...'
# the label of the docker image as pushed to the docker registry configured for the environment test
DOCKER_IMAGE_VERSION=bebea131
# executes signin and redeploycontainers via jelastic_cli
"$dir_of_tegonal_scripts/ci/jelastic/deploy.sh" -l "$JELASTIC_LOGIN" -p "$JELASTIC_PASSWORD" -u "$JELASTIC_PLATFORM_URL" -e "test" -n cp -t "$DOCKER_IMAGE_VERSION"
# you can also source
sourceOnce "$dir_of_tegonal_scripts/ci/jelastic/deploy.sh"
jelastic_deploy -l "$JELASTIC_LOGIN" -p "$JELASTIC_PASSWORD" -u "$JELASTIC_PLATFORM_URL" -e "test" -n cp -t "$DOCKER_IMAGE_VERSION"In a GitHub workflow you would use it as follows:
jobs:
steps:
- name: deploy shellcheck v0.8.0
run: |
./lib/tegonal-scripts/src/ci/jelastic/deploy.sh \
-l "$JELASTIC_LOGIN" -p "$JELASTIC_PASSWORD" -u "$JELASTIC_PLATFORM_URL" \
-e "test" -n cp \
-t "$DOCKER_IMAGE_VERSION"Help:
Parameters:
-l|--login The user who logs in
-p|--password The access token of the user
-u|--url The platformUrl to the jelastic instance
-e|--env The environment to use
-n|--nodeGroup The nodeGroup to use
-t|--tag The tag which shall be deployed
--help prints this help
--version prints the version of this script
INFO: Version of deploy.sh is:
v4.3.0-SNAPSHOT
The most important functions are defined in this file: jelastic_signin which in turn uses the generic jelastic_exec
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/ci/jelastic/jelastic-utils.sh"
# typically you would define those via secrets (GitHub) or Variables (Gitlab)
JELASTIC_LOGIN='my-user'
JELASTIC_PASSWORD='access-token'
JELASTIC_PLATFORM_URL='https://...'
# before doing anything with jelastic cli, you need to signin
# this is just a helper function you could also use jelastic_exec and pass users/authentication/signin as command
jelastic_signin "$JELASTIC_PLATFORM_URL" "$JELASTIC_LOGIN" "$JELASTIC_PASSWORD"
# generic utility which executes the jelastic_cli with the corresponding command and args but,
# in contrast to the cli, it checks whether the response contained `result: 0` or not
jelastic_exec "environment/control/redeploycontainers" --envName "test" --nodeGroup "cp" --tag "a123e2"The scripts under this topic (in directory qa) perform checks or execute qa tools.
A function which expects the name of an array of dirs as first argument and a source path as second argument (which is passed to shellcheck via -P parameter). It then executes shellcheck for each *.sh in these directories with predefined settings for shellcheck.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/qa/run-shellcheck.sh"
# shellcheck disable=SC2034 # is passed by name to runShellcheck
declare -a dirs=(
"$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/../scripts"
"$dir_of_tegonal_scripts/../spec"
)
declare sourcePath="$dir_of_tegonal_scripts"
runShellcheck dirs "$sourcePath"If you are using gt then you most likely want to be sure that your pull-hook.sh files
don't contain shell issues, you can use the function runShellCheckPullHooks which analyses all pull-hook.sh files
in the remotes dir of gt using the $dir_of_tegonal_scripts as source path.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/qa/run-shellcheck-pull-hooks.sh"
# pass the working directory of gt which usually is .gt in the root of your repository
runShellcheckPullHooks ".gt"Utility function which checks if shellspec is installed and if so executes it and prints a warning otherwise. Intended to be used in before-pr.sh where contributors shall not be forced to have shellspec installed
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/qa/run-shellspec-if-installed.sh"
runShellspecIfInstalled
# you can also pass arguments to shellspec
runShellspecIfInstalled --jobs 2The scripts under this topic (in directory releasing) perform some steps of your release process.
Script which releases a version for a repository containing files which don't need to be compiled or packaged. Instead, they will be signed by a specified gpg key where its public key, defined in .gt/signing-key.public.asc, will be used to verify the signatures.
This script is useful if you want to release e.g. scripts which can then be fetched via gt.
It uses release-template internally and thus applies the same conventions + the mentioned public key which needs to be defined in .gt/signing-key.public.asc
It executes the same steps as in release-template where scripts located in projectRootDir/src are also updated regarding the version and as explained, in the releaseHook, it signs the files the given --sign-fn finds.
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
-k|key The GPG private key which shall be used to sign the files
--sign-fn Function which is called to determine what files should be signed. It should be based find and allow to pass further arguments (we will i.a. pass -print0)
-b|--branch (optional) The expected branch which is currently checked out -- default: main
--project-dir (optional) The projects directory -- default: .
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
-nv|--next-version (optional) the version to use for prepare-next-dev-cycle -- default: is next minor based on version
--prepare-only (optional) defines whether the release shall only be prepared (i.e. no push, no tag, no prepare-next-dev-cycle) -- default: false
--before-pr-fn (optional) defines the function which is executed before preparing the release (to see if we should release) and after preparing the release -- default: beforePr (per convention defined in scripts/before-pr.sh). No arguments are passed
--prepare-next-dev-cycle-fn (optional) defines the function which is executed to prepare the next dev cycle -- default: perpareNextDevCycle (per convention defined in scripts/prepareNextDevCycle). The following arguments are passed: -v nextVersion --pattern additionalPattern --project-dir projectsRootDir --before-pr-fn beforePrFn
--after-version-update-hook (optional) if defined, then this function is called after versions were updated and before calling beforePr. The following arguments are passed: -v version --project-dir projectsRootDir and --pattern additionalPattern
--help prints this help
--version prints the version of this script
INFO: Version of release-files.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
scriptsDir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)"
sourceOnce "$scriptsDir/before-pr.sh"
function findScripts() {
find "src" -name "*.sh" -not -name "*.doc.sh" "$@"
}
# make the function visible to release-files.sh / not necessary if you source release-files.sh, see further below
declare -fx findScripts
# releases version v0.1.0 using the key 0x945FE615904E5C85 for signing and function findScripts to find the files which
# should be signed (and thus released). Assumes that a function named beforePr is in scope (which we sourced above)
"$dir_of_tegonal_scripts/releasing/release-files.sh" -v v0.1.0 -k "0x945FE615904E5C85" --sign-fn findScripts
# releases version v0.1.0 using the key 0x945FE615904E5C85 for signing and function findScripts to find the files which
## should be signed (and thus released). Moreover, searches for additional occurrences where the version should be
# replaced via the specified pattern
"$dir_of_tegonal_scripts/releasing/release-files.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --sign-fn findScripts \
-p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])"
function specialBeforePr(){
beforePr && echo "imagine some additional work"
}
# make the function visible to release-files.sh / not necessary if you source prepare-files-next-dev-cycle.sh
# see further below
declare -fx specialBeforePr
# releases version v0.1.0 using the key 0x945FE615904E5C85 for signing and
"$dir_of_tegonal_scripts/releasing/release-files.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --sign-fn findScripts \
--before-pr-fn specialBeforePr
# in case you want to provide your own release.sh and only want to do some pre-configuration
# then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/release-files.sh"
# and then call the function with your pre-configuration settings:
# here we define the function which shall be used to find the files to be signed
# since "$@" follows afterwards, one could still override it via command line arguments.
# put "$@" first, if you don't want that a user can override your pre-configuration
releaseFiles --sign-fn findScripts "$@"
# call the function define --before-pr-fn, don't allow to override via command line arguments
releaseFiles "$@" --before-pr-fn specialBeforePrScript which prepares files for a next development cycle (typically used together with release files). it uses the prepare next dev cycle template and thus is based on the same conventions.
Parameters:
-v the version for which we prepare the dev cycle
--project-dir (optional) The projects directory -- default: .
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--before-pr-fn (optional) defines the function which is executed before preparing the release (to see if we should release) and after preparing the release -- default: beforePr (per convention defined in scripts/before-pr.sh). No arguments are passed
--after-version-update-hook (optional) if defined, then this function is called after versions were updated and before calling beforePr. The following arguments are passed: -v version --project-dir projectsRootDir and --pattern additionalPattern
--help prints this help
--version prints the version of this script
INFO: Version of prepare-files-next-dev-cycle.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
scriptsDir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)"
sourceOnce "$scriptsDir/before-pr.sh"
# prepare dev cycle for version v0.2.0, assumes a function beforePr is in scope which we sourced above
"$dir_of_tegonal_scripts/releasing/prepare-files-next-dev-cycle.sh" -v v0.2.0
function specialBeforePr(){
beforePr && echo "imagine some additional work"
}
# make the function visible to release-files.sh / not necessary if you source prepare-files-next-dev-cycle.sh, see further below
declare -fx specialBeforePr
# prepare dev cycle for version v0.2.0 and
# searches for additional occurrences where the version should be replaced via the specified pattern in:
# - script files in ./src and ./scripts
# - ./README.md
# uses specialBeforePr instead of beforePr
"$dir_of_tegonal_scripts/releasing/prepare-files-next-dev-cycle.sh" -v v0.2.0 \
-p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])" \
--before-pr-fn specialBeforePr
# in case you want to provide your own release.sh and only want to do some pre-configuration
# then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/prepare-files-next-dev-cycle.sh"
# and then call the function with your pre-configuration settings:
# here we define the pattern which shall be used to replace further version occurrences
# since "$@" follows afterwards, one could still override it via command line arguments.
# put "$@" first, if you don't want that a user can override your pre-configuration
prepareNextDevCycle -p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])" "$@"
# call the function define --before-pr-fn, don't allow to override via command line arguments
prepareNextDevCycle "$@" --before-pr-fn specialBeforePrDefines a release process template where some conventions are defined:
- expects a version in format vX.Y.Z(-RC...)
- main is your default branch (or you use --branch to define another)
- requires you to have a function beforePr in scope (or you define another one via --before-pr-fn)
- requires you to have a function prepareNextDevCycle in scope (or you define another one via --prepare-next-dev-cycle-fn)
It then executes the following steps:
- git pre-release checks
- check
beforePrFncan be executed without problems - update version common release steps
- call the afterVersionUpdateHook if defined
- check again
beforePrFnis not broken - call the releaseHook
- commit changes, create tag
- execute
prepareNextDevCycleFn(which typically creates a commit as well) - push tag and commits
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
--release-hook performs the main release task such as (run tests) create artifacts, deploy artifacts
-b|--branch (optional) The expected branch which is currently checked out -- default: main
--project-dir (optional) The projects directory -- default: .
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
-nv|--next-version (optional) the version to use for prepare-next-dev-cycle -- default: is next minor based on version
--prepare-only (optional) defines whether the release shall only be prepared (i.e. no push, no tag, no prepare-next-dev-cycle) -- default: false
--before-pr-fn (optional) defines the function which is executed before preparing the release (to see if we should release) and after preparing the release -- default: beforePr (per convention defined in scripts/before-pr.sh). No arguments are passed
--prepare-next-dev-cycle-fn (optional) defines the function which is executed to prepare the next dev cycle -- default: perpareNextDevCycle (per convention defined in scripts/prepareNextDevCycle). The following arguments are passed: -v nextVersion --pattern additionalPattern --project-dir projectsRootDir --before-pr-fn beforePrFn
--after-version-update-hook (optional) if defined, then this function is called after versions were updated and before calling beforePr. The following arguments are passed: -v version --project-dir projectsRootDir and --pattern additionalPattern
--help prints this help
--version prints the version of this script
INFO: Version of release-template.sh is:
v4.3.0-SNAPSHOT
Full example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
function releaseScalaLib() {
sbt publishSigned
# or
sbt test publishedSigned
}
# make the function visible to release-templates.sh / not necessary if you source release-templates.sh, see further below
declare -fx releaseScalaLib
# releases version v0.1.0 using releaseScalaLib as hook
"$dir_of_tegonal_scripts/releasing/release-template.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --release-hook releaseScalaLib
# releases version v0.1.0 using releaseScalaLib as hook and
# searches for additional occurrences where the version should be replaced via the specified pattern in:
# - script files in ./src and ./scripts
# - ./README.md
"$dir_of_tegonal_scripts/releasing/release-template.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --release-hook releaseScalaLib \
-p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])"
# in case you want to provide your own release.sh and only want to do some pre-configuration
# (such as specify the release-hook) then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/release-template.sh"
# and then call the function with your pre-configuration settings:
# here we define the function which shall be used as release-hook after "$@" this way one cannot override it.
# put --release-hook before "$@" if you want to define only a default
releaseTemplates "$@" --release-hook releaseScalaLib
function releaseScalaLib_afterVersionUpdateHook() {
# some additional version bumps (assuming version is in scope)
local version
perl -0777 -i -pe "s/.../$version/g" "build.sbt"
}
# and then call the function with your pre-configuration settings:
# here we define the function which shall be used as release-hook after "$@" this way one cannot override it.
# put --release-hook before "$@" if you want to define only a default
releaseTemplate "$@" --release-hook releaseScalaLib \
--after-version-update-hook releaseScalaLib_afterVersionUpdateHooktemplate to prepare a next releases, updating version and such using update-version-common-steps.sh
Help:
Parameters:
-v the version for which we prepare the dev cycle
--project-dir (optional) The projects directory -- default: .
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--before-pr-fn (optional) defines the function which is executed before preparing the release (to see if we should release) and after preparing the release -- default: beforePr (per convention defined in scripts/before-pr.sh). No arguments are passed
--after-version-update-hook (optional) if defined, then this function is called after versions were updated and before calling beforePr. The following arguments are passed: -v version --project-dir projectsRootDir and --pattern additionalPattern
--help prints this help
--version prints the version of this script
INFO: Version of prepare-next-dev-cycle-template.sh is:
v4.3.0-SNAPSHOT
Full example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
function prepareNextAfterVersionUpdateHook() {
# some additional version bumps e.g. using perl
perl -0777 -i #...
}
# make the function visible to release-templates.sh / not necessary if you source release-templates.sh, see further below
declare -fx releaseScalaLib
# releases version v0.1.0 using releaseScalaLib as hook
"$dir_of_tegonal_scripts/releasing/release-template.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --release-hook releaseScalaLib
# releases version v0.1.0 using releaseScalaLib as hook and
# searches for additional occurrences where the version should be replaced via the specified pattern in:
# - script files in ./src and ./scripts
# - ./README.md
"$dir_of_tegonal_scripts/releasing/release-files.sh" \
-v v0.1.0 -k "0x945FE615904E5C85" --release-hook releaseScalaLib \
-p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])"
# in case you want to provide your own release.sh and only want to do some pre-configuration
# (such as specify the release-hook) then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/release-template.sh"
# and then call the function with your pre-configuration settings:
# here we define the function which shall be used as release-hook after "$@" this way one cannot override it.
# put --release-hook before "$@" if you want to define only a default
releaseTemplates "$@" --release-hook releaseScalaLibchecks if the repo is ready to be released for a given version
- expects a version in format vX.Y.Z(-RC...)
- you are currently on
main(or use--branchto define a different expected branch) - your branch is up-to-date with
origin
it assists you in pulling/rebasing etc. in case you are on the wrong branch or behind origin.
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
-b|--branch (optional) The expected branch which is currently checked out -- default: main
--help prints this help
--version prints the version of this script
INFO: Version of pre-release-checks-git.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
# checks releasing v0.1.0 makes sense and the current branch is main
"$dir_of_tegonal_scripts/releasing/pre-release-checks-git.sh" -v v0.1.0
# checks releasing v0.1.0 makes sense and the current branch is hotfix-1.0
"$dir_of_tegonal_scripts/releasing/pre-release-checks-git.sh" -v v0.1.0 -b hotfix-1.0Assumes you have configured your sbt project to publish to sonatype (or any other repo) where you have defined to use SONATYPE_USER and SONATYPE_PW as env vars for your credentials. I.e. your build.sbt file will contain something like:
credentials += Credentials(
"Sonatype Nexus Repository Manager",
"oss.sonatype.org",
sys.env.getOrElse("SONATYPE_USER", ""),
sys.env.getOrElse("SONATYPE_PW", "")
)This script asks to fill in those to env vars if not already given an calls sbt publishSigned afterwards passing
them in without exporting them.
Full example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
# ask for SONATYPE_USER and SONATYPE_PW (unless already exported beforehand) and calls sbt publishSigned
"$dir_of_tegonal_scripts/releasing/sbt-publish-to-sonatype.sh"
# predefine SONATYPE_USER, asks for SONATYPE_PW (unless already exported beforehand) and calls sbt publishSigned
SONATYPE_USER="kshjwo2" "$dir_of_tegonal_scripts/releasing/sbt-publish-to-sonatype.sh"
# if you use it in combination with other files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/sbt-publish-to-sonatype.sh"
# and then call the function
sbtPublishToSonatype
SONATYPE_USER="kshjwo2" sbtPublishToSonatypePerforms several releasing scripts defined in the following sections:
- Updates the version in *.sh (see Update Version in bash scripts) defined in /scripts and .gt/**/pull-hook.sh
- Updates the version in .github/ISSUE_TEMPLATE/**.y(a)ml files ( see Update Version in issue templates)
- Updates the version in the README.md (see next section Update Version in README).
- activates the release section and hides the main section if
-for-releaseistrue(the opposite otherwise) - hides the sneak-peek banner (or shows it if
--for-releaseisfalse)
Help:
Parameters:
--for-release true if update is for release in which case we hide the sneak-peek banner and toggle sections for release, if false then we show the sneak-peek banner and toggle the section for development
-v The version to release in the format vX.Y.Z(-RC...)
--project-dir (optional) The projects directory -- default: .
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--help prints this help
--version prints the version of this script
INFO: Version of update-version-common-steps.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
# updates the version in headers of different files, hides the sneak-peek banner and
# toggles sections in README.md for release
"$dir_of_tegonal_scripts/releasing/update-version-common-steps.sh" --for-release true -v v0.1.0
# 1. searches for additional occurrences where the version should be replaced via the specified pattern
# 2. git commit all changes and create a tag for v0.1.0
# 3. call scripts/prepare-next-dev-cycle.sh with nextVersion deduced from the specified version (in this case 0.2.0-SNAPSHOT)
# 4. git commit all changes as prepare v0.2.0 dev cycle
# 5. push tag and commits
# 6. releases version v0.1.0 using the key 0x945FE615904E5C85 for signing and
"$dir_of_tegonal_scripts/releasing/update-version-common-steps.sh" \
--for-release true \
-v v0.1.0 -k "0x945FE615904E5C85" \
-p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])"
# in case you want to provide your own release.sh and only want to do some pre-configuration
# then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/update-version-common-steps.sh"
# and then call the function with your pre-configuration settings:
# here we pre-define the additional pattern which shall be used in the search to replace the version
# since "$@" follows afterwards, one could still override it via command line arguments.
# put "$@" first, if you don't want that a user can override your pre-configuration
updateVersionCommonSteps -p "(TEGONAL_SCRIPTS_VERSION=['\"])[^'\"]+(['\"])" "$@"Updates the version used in download badges and in the sneak peek banner. Requires that you follow one of the following schemas for the download badges:
[](<ANY_URL>/v0.2.0)
[](<ANY_URL>=v0.2.0)
And it searches for the following text for the sneak peek banner:
For instance, the [README of v2.0.0](<ANY_URL>/tree/v2.0.0/...)
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
-f|--file (optional) the file where search & replace shall be done -- default: ./README.md
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--help prints this help
--version prints the version of this script
Examples:
# update version for ./README.md
update-version-README.sh -v v0.1.0
# update version for ./docs/index.md
update-version-README.sh -v v0.1.0 -f ./docs/index.md
# update version for ./README.md
# also replace occurrences of the defined pattern
update-version-README.sh -v v0.1.0 -p "(VERSION=['\"])[^'\"]+(['\"])"
INFO: Version of update-version-README.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/releasing/update-version-README.sh" -v 0.1.0
# if you use it in combination with other tegonal-scripts files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/update-version-README.sh"
# and then call the function
updateVersionReadme -v 0.2.0Sets the version placed before the Description section accordingly.
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
-d|--directory (optional) the working directory in which *.sh are searched (also in subdirectories) / you can also specify a file -- default: ./src
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--help prints this help
--version prints the version of this script
Examples:
# update version to v0.1.0 for all *.sh in ./src and subdirectories
update-version-scripts.sh -v v0.1.0
# update version to v0.1.0 for all *.sh in ./scripts and subdirectories
update-version-scripts.sh -v v0.1.0 -d ./scripts
# update version to v0.1.0 for all *.sh in ./src and subdirectories
# also replace occurrences of the defined pattern
update-version-scripts.sh -v v0.1.0 -p "(VERSION=['\"])[^'\"]+(['\"])"
INFO: Version of update-version-scripts.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/releasing/update-version-scripts.sh" -v 0.1.0
# if you use it in combination with other tegonal-scripts files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/update-version-scripts.sh"
# and then call the function
updateVersionReadme -v 0.2.0Replaces the placeholder of the Affected Version field in the given y(a)ml files
Help:
Parameters:
-v The version to release in the format vX.Y.Z(-RC...)
-d|--directory (optional) the working directory in which *.y(a)ml are searched (also in subdirectories) / you can also specify a file -- default: ./.github/ISSUE_TEMPLATE
-p|--pattern (optional) pattern which is used in a perl command (separator /) to search & replace additional occurrences. It should define two match groups and the replace operation looks as follows: \${1}$version\${2}
--help prints this help
--version prints the version of this script
Examples:
# update version to v0.1.0 for all *.y(a)ml in ./.github/ISSUE_TEMPLATE and subdirectories
update-version-issue-templates.sh -v v0.1.0
# update version to v0.1.0 for all *.y(a)ml in ./tpls and subdirectories
update-version-issue-templates.sh -v v0.1.0 -d ./tpls
# update version to v0.1.0 for all *.y(a)ml in ./.github/ISSUE_TEMPLATE and subdirectories
# also replace occurrences of the defined pattern
update-version-issue-templates.sh -v v0.1.0 -p "(VERSION=['\"])[^'\"]+(['\"])"
INFO: Version of update-version-issue-templates.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/releasing/update-issue-templates.sh" -v 0.1.0
# if you use it in combination with other tegonal-scripts files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/update-issue-templates.sh"
# and then call the function
updateVersionIssueTemplate -v 0.2.0Utility to comment/uncomment sections defined via
<!-- for main -->
...
<!-- for main end -->
and
<!-- for release -->
...
<!-- for release end -->
depending on the passed command:
- Passing
mainwill uncomment main sections and comment release sections. - Passing
releasewill uncomment release sections and comment main sections.
Help:
Parameters:
-c|--command either 'main' or 'release'
-f|--file (optional) the file where search & replace shall be done -- default: ./README.md
--help prints this help
--version prints the version of this script
Examples:
# comment the release sections in ./README.md and uncomment the main sections
toggle-sections.sh -c main
# comment the main sections in ./docs/index.md and uncomment the release sections
toggle-sections.sh -c release -f ./docs/index.md
INFO: Version of toggle-sections.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/releasing/toggle-sections.sh" -c main
# if you use it in combination with other files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/toggle-sections.sh"
# and then call the function
toggleSections -c releaseIn case you use a sneak peek banner as we do in this repo, then this script can be used to hide it (before tagging) and show it again in the new dev cycle.
Help:
Parameters:
-c|--command either 'show' or 'hide'
-f|--file (optional) the file where search & replace shall be done -- default: ./README.md
--help prints this help
--version prints the version of this script
Examples:
# hide the sneak peek banner in ./README.md
sneak-peek-banner.sh -c hide
# show the sneak peek banner in ./docs/index.md
sneak-peek-banner.sh -c show -f ./docs/index.md
INFO: Version of sneak-peek-banner.sh is:
v4.3.0-SNAPSHOT
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
"$dir_of_tegonal_scripts/releasing/sneak-peek-banner.sh" -c hide
# if you use it in combination with other files, then you might want to source it instead
sourceOnce "$dir_of_tegonal_scripts/releasing/sneak-peek-banner.sh"
# and then call the function
sneakPeekBanner -c showThe scripts under this topic (in directory utility) are useful for bash programming as such.
Utility functions when dealing with arrays.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/array-utils.sh"
declare regex
regex=$(joinByChar '|' my regex alternatives)
declare -a commands=(add delete list config)
regex=$(joinByChar '|' "${commands[@]}")
joinByString ', ' a list of strings and the previously defined "$regex"
declare -a names=(alwin darius fabian mike mikel robert oliver thomas)
declare employees
employees=$(joinByString ", " "${names[@]}")
echo ""
echo "Tegonal employees are currently: $employees"
function startingWithA() {
[[ $1 == a* ]]
}
declare -a namesStartingWithA=()
arrFilter names namesStartingWithA startingWithA
declare -p namesStartingWithA
declare -a everySecondName
arrTakeEveryX names everySecondName 2 0
declare -p everySecondName
declare -a everySecondNameStartingFrom1
arrTakeEveryX names everySecondNameStartingFrom1 2 1
declare -p everySecondNameStartingFrom1
arrStringEntryMaxLength names # 6Utility functions to interact with the user.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/ask.sh"
if askYesOrNo "shall I say hello"; then
echo "hello"
fi
function noAnswerCallback {
echo "hm... no answer, I am sad :("
}
timeoutInSeconds=30
readArgs='' # i.e. no additional args passed to read
answer='default value used if there is no answer'
askWithTimeout "some question" "$timeoutInSeconds" noAnswerCallback answer "$readArgs"
echo "$answer"Utility functions which shall help to keep your repo clean and tidy.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
projectDir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/.."
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$projectDir/lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/cleanups.sh"
# e.g. in scripts/cleanup-on-push-to-main.sh
function cleanupOnPushToMain() {
removeUnusedSignatures "$projectDir"
logSuccess "cleanup done"
}Utility functions which check some conditions like is passed arg the correct type etc.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/checks.sh"
function foo() {
# shellcheck disable=SC2034 # is passed by name to checkArgIsArray
local -rn arr=$1
local -r fn=$2
local -r bool=$3
local -r version=$4
# resolves arr recursively via recursiveDeclareP and check that is a non-associative array
checkArgIsArray arr 1 # same as exitIfArgIsNotArray if set -e has an effect on this line
checkArgIsFunction "$fn" 2 # same as exitIfArgIsNotFunction if set -e has an effect on this line
checkArgIsBoolean "$bool" 3 # same as exitIfArgIsNotBoolean if set -e has an effect on this line
checkArgIsVersion "$version" 4 # same as exitIfArgIsNotVersion if set -e has an effect on this line
# shellcheck disable=SC2317 # is passed by name to checkArgIsArrayWithTuples
function describeTriple() {
echo >&2 "array contains 3-tuples with names where the first value is the first-, the second the middle- and the third the lastname"
}
# check array with 3-tuples
checkArgIsArrayWithTuples arr 3 "names" 1 describeTriple
exitIfArgIsNotArray arr 1
exitIfArgIsNotArrayOrIsEmpty arr 1
exitIfArgIsNotFunction "$fn" 2
exitIfArgIsNotBoolean "$bool" 3
exitIfArgIsNotVersion "$version" 4
# shellcheck disable=SC2317 # is passed by name to exitIfArgIsNotArrayWithTuples
function describePair() {
echo >&2 "array contains 2-tuples with names where the first value is the first-, and the second the last name"
}
# check array with 2-tuples
exitIfArgIsNotArrayWithTuples arr 2 "names" 1 describePair
}
if checkCommandExists "cat"; then
echo "do whatever you want to do..."
fi
# give a hint how to install the command
checkCommandExists "git" "please install it via https://git-scm.com/downloads"
# same as checkCommandExists but exits instead of returning non-zero in case command does not exist
exitIfCommandDoesNotExist "git" "please install it via https://git-scm.com/downloads"
# meant to be used in a file which is sourced where a contract exists between the file which `source`s and the sourced file
exitIfVarsNotAlreadySetBySource myVar1 var2 var3
declare myVar4
exitIfVariablesNotDeclared myVar4 myVar5 # would exit because myVar5 is not set
echo "myVar4 $myVar4"
declare currentDir
currentDir=$(pwd)
checkPathNamedIsInsideOf "$myVar4" "source directory" "$currentDir" # same as exitIfPathNamedIsOutsideOf if set -e has an effect on this line
exitIfPathNamedIsOutsideOf "$myVar4/plugins.txt" "plugins" "$currentDir"Date utils around date and co
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
projectDir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/.."
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$projectDir/lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/date-utils.sh"
# converts the unix timestamp to a date in format Y-m-dTH:M:S
timestampToDateTime 1662981524 # outputs 2022-09-12T13:18:44
dateToTimestamp "2024-03-01" # outputs 1709247600
dateToTimestamp "2022-09-12T13:18:44" # outputs 1662981524Utility functions around git.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/git-utils.sh"
declare currentBranch
currentBranch=$(currentGitBranch)
echo "current git branch is: $currentBranch"
if hasGitChanges; then
echo "do whatever you want to do..."
fi
if localGitIsAhead "main"; then
echo "do whatever you want to do..."
elif localGitIsAhead "main" "anotherRemote"; then
echo "do whatever you want to do..."
fi
if localGitIsBehind "main"; then
echo "do whatever you want to do..."
elif localGitIsBehind "main"; then
echo "do whatever you want to do..."
fi
if hasRemoteTag "v0.1.0"; then
echo "do whatever you want to do..."
elif hasRemoteTag "v0.1.0" "anotherRemote"; then
echo "do whatever you want to do..."
fi
echo "all existing tags on remote origin, starting from smallest to biggest version number"
remoteTagsSorted
# if you specify the name of the remote, then all additional arguments are passed to `sort` which is used internally
echo "all existing tags on remote upstream, starting from smallest to biggest version number"
remoteTagsSorted upstream -r
declare latestTag
latestTag=$(latestRemoteTag)
echo "latest tag on origin: $latestTag"
latestTag=$(latestRemoteTag upstream)
echo "latest tag on upstream: $latestTag"
latestTag=$(latestRemoteTag origin "^v1\.[0-9]+\.[0-9]+$")
echo "latest tag in the major 1.x.x series on origin without release candidates: $latestTag"Utility functions which hopefully make it easier for you to deal with gpg
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/gpg-utils.sh"
# import public-key.asc into gpg store located at ~/.gpg and trust automatically
importGpgKey ~/.gpg ./public-key.asc
# import public-key.asc into gpg store located at ~/.gpg but ask given question first which needs to be answered with yes
importGpgKey ~/.gpg ./public-key.asc "do you want to import the shown key(s)?"
# import public-key.asc into gpg store located at .gt/remotes/tegonal-scripts/public-keys/gpg
# and trust automatically
importGpgKey .gt/remotes/tegonal-scripts/public-keys/gpg ./public-key.asc
# trust key which is identified via [email protected] in gpg store located at ~/.gpg
trustGpgKey ~/.gpg [email protected]
# get the gpg key data one can retrieve via --list-key --with-colons (pub or sub) for the key which signed the given file
getSigningGpgKeyData "file.sig"
# get the gpg key data one can retrieve via --list-key --with-colons (pub or sub) for the key which signed the given file
# but searches the key not in the default gpg store but in .gt/remotes/tegonal-scripts/public-keys/gpg
getSigningGpgKeyData "file.sig" .gt/remotes/tegonal-scripts/public-keys/gpg
# returns the creation date of the signature
getSigCreationDate "file.sig"
keyData="sub:-:4096:1:4B78012139378220:..."
# extract the key id from the given key data
extractGpgKeyIdFromKeyData "$keyData"
# extract the expiration timestamp from the given key data
extractExpirationTimestampFromKeyData "$keyData"
# returns with 0 if the given key data (the key respectively) is expired, non-zero otherwise
isGpgKeyInKeyDataExpired "$keyData"
# returns with 0 if the given key data (the key respectively) was revoked, non-zero otherwise
isGpgKeyInKeyDataRevoked "$keyData"
# returns the revocation data one can retrieve via --list-sigs --with-colons (rev) for the given key
getRevocationData 4B78012139378220
# returns the revocation data one can retrieve via --list-sigs --with-colons (rev) for the given key
# but searches the revocation not in the default gpg store but in .gt/remotes/tegonal-scripts/public-keys/gpg
getRevocationData 4B78012139378220 .gt/remotes/tegonal-scripts/public-keys/gpg
# extract the creation timestamp from the given revocation data
extractCreationTimestampFromRevocationData
# list all signatures of the given key and highlights it in the output (which especially useful if the key is a subkey
# and there are other subkeys)
listSignaturesAndHighlightKey 4B78012139378220
# list all signatures of the given key and highlights it in the output (which especially useful if the key is a subkey
# and there are other subkeys) but searches the revocation not in the default gpg store but in
# .gt/remotes/tegonal-scripts/public-keys/gpg
listSignaturesAndHighlightKey 4B78012139378220 .gt/remotes/tegonal-scripts/public-keys/gpg#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/http.sh"
# downloads https://.../signing-key.public.asc and https://.../signing-key.public.asc.sig and verifies it with gpg
wgetAndVerify "https://github.com/tegonal/gt/.gt/signing-key.public.asc"#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/io.sh"
function readFile() {
cat "$1" >&3
echo "reading from 4 which was written to 3"
local line
while read -u 4 -r line; do
echo "$line"
done
}
# creates file descriptors 3 (output) and 4 (input) based on temporary files
# executes readFile and closes the file descriptors again
withCustomOutputInput 3 4 readFile "my-file.txt"
# First tries to set chmod 777 to the directory and all files within it and then deletes the directory
deleteDirChmod777 ".git"Utility functions to log messages including a severity level where logError writes to stderr
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/log.sh"
logInfo "hello %s" "world"
# INFO: hello world
logInfo "line %s" 1 2 3
# INFO: line 1
# INFO: line 2
# INFO: line 3
logWarning "oho..."
# WARNING: oho...
logError "illegal state..."
# ERROR: illegal state...
seconds=54
logSuccess "import finished in %s seconds" "$seconds"
# SUCCESS: import finished in 54 seconds
die "fatal error, shutting down"
# ERROR: fatal error, shutting down
# exit 1
returnDying "fatal error, shutting down"
# ERROR: fatal error, shutting down
# return 1
# in case you don't want a newline at the end of the message, then use one of
logInfoWithoutNewline "hello"
# INFO: hello%
logWarningWithoutNewline "be careful"
logErrorWithoutNewline "oho"
logSuccessWithoutNewline "yay"
traceAndDie "fatal error, shutting down"
# ERROR: fatal error, shutting down
#
# Stacktrace:
# foo @ /opt/foo.sh:32:1
# bar @ /opt/bar.sh:10:1
# ...
# exit 1
traceAndReturnDying "fatal error, shutting down"
# ERROR: fatal error, shutting down
#
# Stacktrace:
# foo @ /opt/foo.sh:32:1
# bar @ /opt/bar.sh:10:1
# ...
# return 1
printStackTrace
# Stacktrace:
# foo @ /opt/foo.sh:32:1
# bar @ /opt/bar.sh:10:1
# main @ /opt/main.sh:4:1We provide three scripts helping in parsing command line arguments:
- parse-args.sh which expects named arguments
- parse-fn-args which is intended to be used in functions and only supports positional arguments
- parse-command.sh which simplifies the delegation to corresponding command functions
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
MY_LIB_VERSION="v1.1.0"
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/parse-args.sh"
# declare all parameter names here (used as identifier afterwards)
declare pattern version directory
# parameter definitions where each parameter definition consists of three values (separated via space)
# VARIABLE_NAME PATTERN HELP_TEXT
# where the HELP_TEXT is optional in the sense of that you can use an empty string
# shellcheck disable=SC2034 # is passed by name to parseArguments
declare params=(
pattern '-p|--pattern' ''
version '-v' 'the version'
directory '-d|--directory' '(optional) the working directory -- default: .'
)
# optional: you can define examples which are included in the help text -- use an empty string for no example
declare examples
# `examples` is used implicitly in parse-args, here shellcheck cannot know it and you need to disable the rule
examples=$(
cat <<EOM
# analyse in the current directory using the specified pattern
analysis.sh -p "%{21}" -v v0.1.0
EOM
)
parseArguments params "$examples" "$MY_LIB_VERSION" "$@"
# in case there are optional parameters, then fill them in here before calling exitIfNotAllArgumentsSet
if ! [[ -v directory ]]; then directory="."; fi
exitIfNotAllArgumentsSet params "$examples" "$MY_LIB_VERSION"
# pass your variables storing the arguments to other scripts
echo "p: $pattern, v: $version, d: $directory"Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
if ! [[ -v dir_of_tegonal_scripts ]]; then
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
fi
sourceOnce "$dir_of_tegonal_scripts/utility/parse-fn-args.sh"
function myFunction() {
# declare the variable you want to use and repeat in `declare params`
local command dir
# shellcheck disable=SC2034 # is passed by name to parseFnArgs
local -ra params=(command dir)
parseFnArgs params "$@"
# pass your variables storing the arguments to other scripts
echo "command: $command, dir: $dir"
}
function myFunctionWithVarargs() {
# in case you want to use a vararg parameter as last parameter then name your last parameter for `params` varargs:
local command dir varargs
# shellcheck disable=SC2034 # is passed by name to parseFnArgs
local -ra params=(command dir varargs)
parseFnArgs params "$@"
# use varargs in another script
echo "command: $command, dir: $dir, varargs: ${varargs*}"
}Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
MY_LIB_VERSION="v1.1.0"
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
sourceOnce "$dir_of_tegonal_scripts/utility/parse-commands.sh"
# command definitions where each command definition consists of two values (separated via space)
# COMMAND_NAME HELP_TEXT
# where the HELP_TEXT is optional in the sense of that you can use an empty string
# shellcheck disable=SC2034 # is passed by name to parseCommands
declare commands=(
add 'command to add people to your list'
config 'manage configuration'
login ''
)
# the function which is responsible to load the corresponding file which contains the function of this particular command
function sourceCommand() {
local -r command=$1
shift
sourceOnce "my-lib-$command.sh"
}
# pass:
# 1. supported commands
# 2. version which shall be shown in --version and --help
# 3. source command, responsible to load the files
# 4. the prefix used for the commands. e.g. command show with prefix my_lib_ results in calling a
# function my_lib_show if the users wants to execute command show
# 5. arguments passed to the corresponding function
parseCommands commands "$MY_LIB_VERSION" sourceCommand "my_lib_" "$@"Utility functions when parsing (see also Parse arguments).
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
MY_LIBRARY_VERSION="v1.0.3"
if ! [[ -v dir_of_tegonal_scripts ]]; then
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
fi
sourceOnce "$dir_of_tegonal_scripts/utility/parse-utils.sh"
function myParseFunction() {
while (($# > 0)); do
if [[ $1 == "--version" ]]; then
shift 1 || traceAndDie "could not shift by 1"
printVersion "$MY_LIBRARY_VERSION"
fi
#...
done
}
function myVersionPrinter() {
# 3 defines that printVersion shall skip 3 stack frames to deduce the name of the script
# makes only sense if we already know that this method is called indirectly
printVersion "$MY_LIBRARY_VERSION" 3
}Utility function to find out the initial declare statement after following declare -n statements
#!/usr/bin/env bash
# shellcheck disable=SC2034
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/utility/recursive-declare-p.sh"
declare -i tmp=1
declare -n ref1=tmp
declare -n ref2=ref1
declare -n ref3=ref2
declare r0 r1 r2 r3
r0=$(recursiveDeclareP tmp)
r1=$(recursiveDeclareP ref1)
r2=$(recursiveDeclareP ref2)
r3=$(recursiveDeclareP ref3)
printf "%s\n" "$r0" "$r1" "$r2" "$r3"
# declare -i tmp="1"
# declare -i tmp="1"
# declare -i tmp="1"
# declare -i tmp="1"If you want to include some code in markdown files (or any other HTML-like file) then replace-snippet.sh could come in handy.
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/utility/replace-snippet.sh"
declare file
file=$(mktemp)
echo "<my-script></my-script>" > "$file"
declare dir fileName output
dir=$(dirname "$file")
fileName=$(basename "$file")
output=$(echo "replace with your command" | grep "command")
# replaceSnippet file id dir pattern snippet
replaceSnippet my-script.sh my-script-help "$dir" "$fileName" "$output"
echo "content"
cat "$file"
# will search for <my-script-help>...</my-script-help> in the temp file and replace it with
# <my-script-help>
#
# <!-- auto-generated, do not modify here but in my-snippet -->
# ```
# output of executing $(myCommand)
# ```
# </my-script-help>Establishes a guard by creating a variable based on the file which shall be sourced.
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/utility/source-once.sh"
sourceOnce "foo.sh" # creates a variable named sourceOnceGuard_foo__sh which acts as guard and sources foo.sh
sourceOnce "foo.sh" # will source nothing as sourceOnceGuard_foo__sh is already defined
unset sourceOnceGuard_foo__sh # unsets the guard
sourceOnce "foo.sh" # is sourced again and the guard established
# you can also use sourceAlways instead of unsetting and using sourceOnce.
sourceAlways "foo.sh"
# creates a variable named sourceOnceGuard_bar__foo__sh which acts as guard and sources bar/foo.sh
sourceOnce "bar/foo.sh"
# will source nothing, only the parent dir + file is used as identifier
# i.e. the corresponding guard is sourceOnceGuard_bar__foo__sh and thus this file is not sourced
sourceOnce "asdf/bar/foo.sh"
declare guard
guard=$(determineSourceOnceGuard "src/bar.sh")
# In case you don't want that a certain file is sourced, then you can define the guard yourself
# this will prevent that */src/bar.sh is sourced
printf -v "$guard" "%s" "true"Updates the Usage section of a bash file based on a sibling doc which is named *.doc.sh (e.g foo.sh and foo.doc.sh).
Moreover, it uses Replace Snippets to update a corresponding snippet in the specified files.
Full usage example:
#!/usr/bin/env bash
set -euo pipefail
shopt -s inherit_errexit
# Assumes tegonal's scripts were fetched with gt - adjust location accordingly
dir_of_tegonal_scripts="$(cd -- "$(dirname -- "${BASH_SOURCE[0]:-$0}")" >/dev/null && pwd 2>/dev/null)/../lib/tegonal-scripts/src"
source "$dir_of_tegonal_scripts/setup.sh" "$dir_of_tegonal_scripts"
source "$dir_of_tegonal_scripts/utility/update-bash-docu.sh"
find . -name "*.sh" \
-not -name "*.doc.sh" \
-print0 |
while read -r -d $'\0' script; do
declare script="${script:2}"
updateBashDocumentation "$dir_of_tegonal_scripts/$script" "${script////-}" . README.md
doneOur thanks go to code contributors as well as all other contributors (e.g. bug reporters, feature request creators etc.)
You are more than welcome to contribute as well:
- star this repository if you like/use it
- open a bug if you find one
- Open a new discussion if you are missing a feature
- ask a question so that we better understand where our scripts need to improve.
- have a look at the help wanted issues if you would like to code.
Please have a look at CONTRIBUTING.md for further suggestions and guidelines.
The provided scripts are licensed under Apache 2.0.