labkey / githubactions Goto Github PK

This is another personal thing that I think lends clarity.

When creating a string that contains both literal and interpolated/expanded values, use bash's more explicit variable notation:

SNAPSHOT_BRANCH="release${RELEASE_NUM}-SNAPSHOT"

I try to run a tool called shellcheck over all my shell scripts.
It'll help you catch a bunch of stuff and generally offers good explanation of why you'd prefer its corrections.
https://github.com/koalaman/shellcheck

Another small sanity checker I use for packard is yamllint:
https://github.com/adrienverge/yamllint

This might be a personal thing, but for clarity, I find its easier to stick to either &&, || OR if .. then statements.

So the above example could be re-written as just:

if echo $GITHUB_REF | grep 'refs/heads'; then
...

Can be written more simply as:

if command -v hub; then
...

Since command will exit with an status/return greater than 0 if there's no matching command on $PATH

Since the $? special variable follows the echo command (which will always exit w/ 0), this if statement will always be true.

There's a bash shell option to help with this kind of logic, set -o pipefail, which causes a command to fail if any constituent command fails.
Read more here: http://redsymbol.net/articles/unofficial-bash-strict-mode

shellcheck will also yell at you for this, but I personally find it helps clarify where this type of expansion is happening.

This can be written as:

TAG="$(echo "$GITHUB_REF" | sed -e 's/refs\/tags\///')"

Double square brackets, are for string comparison and only apply in bash.
In pure sh, you only need [ -z "$VAR" ] to test for an empty/unset variable.

Since bash is being installed, you'll want to make sure its being used for any scripts by specifying a more explicit shebag.
#!/usr/bin/env bash should do the trick.