Add release date to changes

.github/workflows/test.yml

@@ -14,6 +14,7 @@ jobs:
           - platform_name: FreeBSD-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-freebsd
+            cache-cross-binary: true
             expect_file_re: "x86-64.+FreeBSD"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -22,6 +23,7 @@ jobs:
           - platform_name: Linux-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-linux-musl
+            cache-cross-binary: true
             expect_file_re: "ELF.+x86-64"
             expect_cross: "--no-expect-cross"
             expect_stripped: "--expect-stripped"
@@ -30,24 +32,69 @@ jobs:
           - platform_name: Linux-aarch64
             os: ubuntu-20.04
             target: aarch64-unknown-linux-musl
+            cache-cross-binary: true
             expect_file_re: "aarch64"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
             can_test: true
 
-          - platform_name: Linux-aarch64-with-cross-v0.2.3
+          - platform_name: Linux-aarch64 (no cache)
+            os: ubuntu-20.04
+            target: aarch64-unknown-linux-musl
+            cache-cross-binary: false
+            expect_file_re: "aarch64"
+            expect_cross: "--expect-cross"
+            expect_stripped: "--no-expect-stripped"
+            can_test: true
+
+          - platform_name: Linux-aarch64 with cross v0.2.3
             os: ubuntu-20.04
             target: aarch64-unknown-linux-musl
             cross-version: "v0.2.3"
+            cache-cross-binary: true
             expect_file_re: "aarch64"
             expect_cross: "--expect-cross"
             expect_cross_version: "0.2.3"
             expect_stripped: "--no-expect-stripped"
             can_test: true
 
+          - platform_name: Linux-aarch64 with cross v0.2.3 (no cache)
+            os: ubuntu-20.04
+            target: aarch64-unknown-linux-musl
+            cross-version: "v0.2.3"
+            cache-cross-binary: false
+            expect_file_re: "aarch64"
+            expect_cross: "--expect-cross"
+            expect_cross_version: "0.2.3"
+            expect_stripped: "--no-expect-stripped"
+            can_test: true
+
+          - platform_name: Linux-aarch64 with cross 19be834
+            os: ubuntu-20.04
+            target: aarch64-unknown-linux-musl
+            cross-version: "19be834"
+            cache-cross-binary: true
+            expect_file_re: "aarch64"
+            expect_cross: "--expect-cross"
+            expect_cross_version: "19be834"
+            expect_stripped: "--no-expect-stripped"
+            can_test: true
+
+          - platform_name: Linux-aarch64 with cross 19be834
+            os: ubuntu-20.04
+            target: aarch64-unknown-linux-musl
+            cross-version: "19be834"
+            cache-cross-binary: false
+            expect_file_re: "aarch64"
+            expect_cross: "--expect-cross"
+            expect_cross_version: "19be834"
+            expect_stripped: "--no-expect-stripped"
+            can_test: true
+
           - platform_name: Linux-arm
             os: ubuntu-20.04
             target: arm-unknown-linux-musleabi
+            cache-cross-binary: true
             expect_file_re: "32.+ARM"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -56,6 +103,7 @@ jobs:
           - platform_name: Linux-i586
             os: ubuntu-20.04
             target: i586-unknown-linux-musl
+            cache-cross-binary: true
             expect_file_re: "ELF.+80386"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -64,6 +112,7 @@ jobs:
           - platform_name: Linux-i686
             os: ubuntu-20.04
             target: i686-unknown-linux-musl
+            cache-cross-binary: true
             expect_file_re: "ELF.+80386"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -72,6 +121,7 @@ jobs:
           - platform_name: Linux-powerpc
             os: ubuntu-20.04
             target: powerpc-unknown-linux-gnu
+            cache-cross-binary: true
             expect_file_re: "32.+PowerPC"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -80,6 +130,7 @@ jobs:
           - platform_name: Linux-powerpc64
             os: ubuntu-20.04
             target: powerpc64-unknown-linux-gnu
+            cache-cross-binary: true
             expect_file_re: "64.+PowerPC"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -88,6 +139,7 @@ jobs:
           - platform_name: Linux-powerpc64le
             os: ubuntu-20.04
             target: powerpc64le-unknown-linux-gnu
+            cache-cross-binary: true
             expect_file_re: "64.+PowerPC"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -96,6 +148,7 @@ jobs:
           - platform_name: Linux-riscv64
             os: ubuntu-20.04
             target: riscv64gc-unknown-linux-gnu
+            cache-cross-binary: true
             expect_file_re: "64.+RISC-V"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -104,6 +157,7 @@ jobs:
           - platform_name: Linux-s390x
             os: ubuntu-20.04
             target: s390x-unknown-linux-gnu
+            cache-cross-binary: true
             expect_file_re: "64.+S/390"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -112,6 +166,7 @@ jobs:
           - platform_name: NetBSD-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-netbsd
+            cache-cross-binary: true
             expect_file_re: "x86-64.+NetBSD"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -120,6 +175,7 @@ jobs:
           - platform_name: Windows-aarch64
             os: windows-latest
             target: aarch64-pc-windows-msvc
+            cache-cross-binary: true
             expect_file_re: "Aarch64.+Windows"
             expect_cross: "--no-expect-cross"
             expect_stripped: "--no-expect-stripped"
@@ -128,6 +184,7 @@ jobs:
           - platform_name: Windows-i686
             os: windows-latest
             target: i686-pc-windows-msvc
+            cache-cross-binary: true
             expect_file_re: "80386.+Windows"
             expect_cross: "--no-expect-cross"
             expect_stripped: "--expect-stripped"
@@ -136,6 +193,7 @@ jobs:
           - platform_name: Windows-x86_64
             os: windows-latest
             target: x86_64-pc-windows-msvc
+            cache-cross-binary: true
             expect_file_re: "x86-64.+Windows"
             expect_stripped: "--expect-stripped"
             can_test: true
@@ -143,6 +201,7 @@ jobs:
           - platform_name: macOS-x86_64
             os: macOS-latest
             target: x86_64-apple-darwin
+            cache-cross-binary: true
             expect_file_re: "Mach-O.+x86_64"
             expect_cross: "--no-expect-cross"
             expect_stripped: "--expect-stripped"
@@ -151,6 +210,7 @@ jobs:
           - platform_name: macOS-aarch64
             os: macOS-latest
             target: aarch64-apple-darwin
+            cache-cross-binary: true
             expect_file_re: "Mach-O.+arm64"
             expect_cross: "--no-expect-cross"
             expect_stripped: "--expect-stripped"
@@ -170,6 +230,7 @@ jobs:
         with:
           command: both
           cross-version: ${{ matrix.platform.cross-version }}
+          cache-cross-binary: ${{ matrix.platform.cache-cross-binary }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
@@ -178,6 +239,7 @@ jobs:
         with:
           command: test
           cross-version: ${{ matrix.platform.cross-version }}
+          cache-cross-binary: ${{ matrix.platform.cache-cross-binary }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
@@ -186,6 +248,7 @@ jobs:
         with:
           command: build
           cross-version: ${{ matrix.platform.cross-version }}
+          cache-cross-binary: ${{ matrix.platform.cache-cross-binary }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           strip: true
@@ -194,6 +257,7 @@ jobs:
         with:
           command: build
           cross-version: ${{ matrix.platform.cross-version }}
+          cache-cross-binary: ${{ matrix.platform.cache-cross-binary }}
           working-directory: subcrate
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Changes.md

@@ -1,7 +1,12 @@
+## 0.0.13 - 2024-05-18
+
+- It's now possible to set `cross-version` to a git ref like a commit hash or `HEAD`. This will
+  install `cross` from its git repo.
+
 ## 0.0.12 - 2024-02-25
 
 - Bumped the version of `actions/cache` used in this action to v4. The v3 version uses Node 16,
-  which causes warnings when run.
+  which causes warnings when run. Implemented by @hms5232. GH #13.
 
 ## 0.0.11 - 2023-12-17
 

README.md

@@ -55,16 +55,16 @@ jobs:
 
 This action takes the following parameters:
 
-| Key                 | Type                                           | Required? | Description                                                                                                                                                                       |
-| ------------------- | ---------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `command`           | string (one of `build`, `test`, or `both`)     | no        | The command(s) to run. The default is `build`. Running the `test` command will fail with \*BSD targets, non-x86 Windows, and macOS ARM.                                           |
-| `target`            | string                                         | yes       | The target triple to compile for. This should be one of the targets found by running `rustup target list`.                                                                        |
-| `working-directory` | string                                         | no        | The working directory in which to run the `cargo` or `cross` commands. Defaults to the current directory (`.`).                                                                   |
-| `toolchain`         | string (one of `stable`, `beta`, or `nightly`) | no        | The Rust toolchain version to install. The default is `stable`.                                                                                                                   |
-| `GITHUB_TOKEN`      | string                                         | no        | Defaults to the value of `${{ github.token }}`.                                                                                                                                   |
-| `args`              | string                                         | no        | A string-separated list of arguments to be passed to `cross build`, like `--release --locked`.                                                                                    |
-| `strip`             | boolean (`true` or `false`)                    | no        | If this is true, then the resulting binaries will be stripped if possible. This is only possible for binaries which weren't cross-compiled.                                       |
-| `cross-version`     | string                                         | no        | This can be used to set the version of `cross` to use. If specified, it should be a specific `cross` release tag. If this is not set then the latest version will always be used. |
+| Key                 | Type                                           | Required? | Description                                                                                                                                                                                                                                                                                                                                   |
+| ------------------- | ---------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `command`           | string (one of `build`, `test`, or `both`)     | no        | The command(s) to run. The default is `build`. Running the `test` command will fail with \*BSD targets, non-x86 Windows, and macOS ARM.                                                                                                                                                                                                       |
+| `target`            | string                                         | yes       | The target triple to compile for. This should be one of the targets found by running `rustup target list`.                                                                                                                                                                                                                                    |
+| `working-directory` | string                                         | no        | The working directory in which to run the `cargo` or `cross` commands. Defaults to the current directory (`.`).                                                                                                                                                                                                                               |
+| `toolchain`         | string (one of `stable`, `beta`, or `nightly`) | no        | The Rust toolchain version to install. The default is `stable`.                                                                                                                                                                                                                                                                               |
+| `GITHUB_TOKEN`      | string                                         | no        | Defaults to the value of `${{ github.token }}`.                                                                                                                                                                                                                                                                                               |
+| `args`              | string                                         | no        | A string-separated list of arguments to be passed to `cross build`, like `--release --locked`.                                                                                                                                                                                                                                                |
+| `strip`             | boolean (`true` or `false`)                    | no        | If this is true, then the resulting binaries will be stripped if possible. This is only possible for binaries which weren't cross-compiled.                                                                                                                                                                                                   |
+| `cross-version`     | string                                         | no        | This can be used to set the version of `cross` to use. If specified, it should be a specific `cross` release tag (like `v0.2.3`) or a git ref (commit hash, `HEAD`, etc.). If this is not set then the latest released version will always be used. If this is set to a git ref then the version corresponding to that ref will be installed. |
 
 ## How it Works
 
@@ -89,5 +89,5 @@ be stripped either.
 ## Caching Rust Compilation Output
 
 You can use the [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) action with this one
-seemlessly, whether or not a specific build target needs `cross`. There is no special configuration
+seamlessly, whether or not a specific build target needs `cross`. There is no special configuration
 that you need for this. It just works.

action.yml

@@ -36,6 +36,11 @@ inputs:
     description: |
       The version of cross to use. If not specified, then the latest version
       will be used.
+  cache-cross-binary:
+    description: |
+      Cache the cross binary if one is installed. This is primarily for use in
+      tests of this action.
+    default: true
 runs:
   using: composite
   steps:
@@ -58,7 +63,7 @@ runs:
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' }}
-    # We need to accesss this in both this YAML config and shell scripts. It
+    # We need to access this in both this YAML config and shell scripts. It
     # doesn't seem like using ${{ env.RUNNER_TEMP }} works in the YAML config.
     - name: Set directory for installing cross
       id: set-cross-dir
@@ -71,7 +76,7 @@ runs:
       with:
         path: ${{ steps.set-cross-dir.outputs.cross-dir }}/cross
         key: ${{ runner.os }}-${{ steps.determine-cross-version.outputs.cross-version }}
-      if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' }}
+      if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' && inputs.cache-cross-binary == 'true' }}
     - name: Install cross if cross-compiling (*nix)
       shell: bash
       run: install-cross-nix.sh ${{ steps.set-cross-dir.outputs.cross-dir }} ${{ steps.determine-cross-version.outputs.cross-version }}

determine-cross-version.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 set -e
 set -x
 set -o pipefail
@@ -5,11 +7,11 @@ set -o pipefail
 VERSION=$1
 
 if [ -z "$VERSION" ]; then
-    JSON=$( curl \
-                --request GET \
-                --header "Authorization: Bearer $GITHUB_TOKEN" \
-                https://api.github.com/repos/cross-rs/cross/releases/latest )
-    VERSION=$( echo "$JSON" | jq -r ".tag_name")
+    JSON=$(curl \
+        --request GET \
+        --header "Authorization: Bearer $GITHUB_TOKEN" \
+        https://api.github.com/repos/cross-rs/cross/releases/latest)
+    VERSION=$(echo "$JSON" | jq -r ".tag_name")
 fi
 
-echo "cross-version=$VERSION" >> $GITHUB_OUTPUT
+echo "cross-version=$VERSION" >>"$GITHUB_OUTPUT"

dev/bin/install-dev-tools.sh

@@ -1,32 +1,37 @@
 #!/bin/bash
 
 set -eo pipefail
+set -x
 
-function run () {
-    echo $1
-    eval $1
+function run() {
+    echo "$1"
+    eval "$1"
 }
 
-function install_tools () {
+function install_tools() {
     curl --silent --location \
-         https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh |
+        https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh |
         sh
-    run "ubi --project houseabsolute/precious --in ~/bin"
-    run "ubi --project houseabsolute/omegasort --in ~/bin"
+    run "ubi --project houseabsolute/precious --in $HOME/bin"
+    run "ubi --project houseabsolute/omegasort --in $HOME/bin"
+    run "ubi --project koalaman/shellcheck --in $HOME/bin"
+    run "ubi --project mvdan/sh --in $HOME/bin --exe shfmt"
+    run "ubi --project crate-ci/typos --in $HOME/bin"
     run "npm install prettier"
-    run "curl -L https://cpanmin.us/ -o ~/bin/cpanm"
-    run "chmod 0755 ~/bin/cpanm"
-    run "~/bin/cpanm --sudo --notest Perl::Tidy"
+    run "curl -L https://cpanmin.us/ -o $HOME/bin/cpanm"
+    run "chmod 0755 $HOME/bin/cpanm"
+    run "$HOME/bin/cpanm --sudo --notest Perl::Tidy"
 }
 
 if [ "$1" == "-v" ]; then
     set -x
 fi
 
-mkdir -p $HOME/bin
+mkdir -p "$HOME"/bin
 
 set +e
-echo ":$PATH:" | grep --extended-regexp ":$HOME/bin:" >& /dev/null
+echo ":$PATH:" | grep --extended-regexp ":$HOME/bin:" >&/dev/null
+# shellcheck disable=SC2181
 if [ "$?" -eq "0" ]; then
     path_has_home_bin=1
 fi
@@ -40,7 +45,7 @@ install_tools
 
 echo "Tools were installed into $HOME/bin."
 if [ -z "$path_has_home_bin" ]; then
-     echo "You should add $HOME/bin to your PATH."
+    echo "You should add $HOME/bin to your PATH."
 fi
 
 exit 0

git/hooks/pre-commit.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+declare -i status
 status=0
 
 PRECIOUS=$(which precious)
@@ -7,8 +8,7 @@ if [[ -z $PRECIOUS ]]; then
     PRECIOUS=./bin/precious
 fi
 
-"$PRECIOUS" lint -s
-if (( $? != 0 )); then
+if ! "$PRECIOUS" lint -s; then
     status+=1
 fi
 

install-cross-nix.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 set -e
 set -x
 set -o pipefail
@@ -5,14 +7,24 @@ set -o pipefail
 CROSS_DIR="$1"
 VERSION="$2"
 
+cd "$CROSS_DIR"
+
+if [[ -n $VERSION ]] && ! [[ $VERSION =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    cargo install cross --git https://github.com/cross-rs/cross --rev "$VERSION" --force
+    mv "$HOME/.cargo/bin/cross" .
+    CROSS_NO_WARNINGS=0 ./cross --version
+    exit 0
+fi
+
 VERSION_ARGS=""
 if [ -n "$VERSION" ]; then
     VERSION_ARGS="--tag $VERSION"
 fi
 
-cd "$CROSS_DIR"
 export TARGET=.
 curl --silent --location \
-     https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh |
+    https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh |
     sh
+# shellcheck disable=SC2086
 ./ubi --project cross-rs/cross --matching musl --in . $VERSION_ARGS
+CROSS_NO_WARNINGS=0 ./cross --version

precious.toml

@@ -1,7 +1,18 @@
 exclude = [
   "target",
+  "tests/lib/**/*",
 ]
 
+[commands.typos]
+type = "both"
+include = "**/*"
+exclude = "**/*.tar.gz"
+invoke = "once"
+cmd = "typos"
+tidy_flags = "--write-changes"
+ok-exit-codes = 0
+lint-failure-exit-codes = 2
+
 [commands.perltidy]
 type = "both"
 include = [ "**/*.{pl,pm,t,psgi}" ]
@@ -45,3 +56,19 @@ ignore_stderr = [
     "The .+ file is not sorted",
     "The .+ file is not unique",
 ]
+
+[commands.shellcheck]
+type = "lint"
+include = "**/*.sh"
+cmd = "shellcheck"
+ok_exit_codes = 0
+lint_failure_exit_codes = 1
+
+[commands.shfmt]
+type = "both"
+include = "**/*.sh"
+cmd = ["shfmt", "--simplify", "--indent", "4"]
+lint_flags = "--diff"
+tidy_flags = "--write"
+ok_exit_codes = 0
+lint_failure_exit_codes = 1

set-build-command.sh

@@ -1,9 +1,12 @@
+#!/bin/bash
+
 set -e
 set -x
+set -o pipefail
 
 CROSS_DIR="$1"
 if [ -f "$CROSS_DIR/cross" ]; then
-    echo "build-command=$CROSS_DIR/cross" >> $GITHUB_OUTPUT
+    echo "build-command=$CROSS_DIR/cross" >>"$GITHUB_OUTPUT"
 else
-    echo "build-command=cargo" >> $GITHUB_OUTPUT
+    echo "build-command=cargo" >>"$GITHUB_OUTPUT"
 fi

set-cross-compile.sh

@@ -1,12 +1,15 @@
+#!/bin/bash
+
 set -e
 set -x
+set -o pipefail
 
 TARGET="$1"
 
 # On macOS and Windows, we can cross-compile to all possible targets without
 # using cross.
 if uname -a | grep --quiet --extended-regexp -i "darwin|msys|windows"; then
-    echo "needs-cross=false" >> $GITHUB_OUTPUT
+    echo "needs-cross=false" >>"$GITHUB_OUTPUT"
     exit 0
 fi
 
@@ -15,8 +18,8 @@ fi
 # feature. This feature makes it compile openssl itself, which fails without
 # cross.
 if echo "$TARGET" | grep --quiet --extended-regexp -i 'x86_64.+linux-(gnu|musl)'; then
-    echo "needs-cross=false" >> $GITHUB_OUTPUT
+    echo "needs-cross=false" >>"$GITHUB_OUTPUT"
     exit 0
 fi
 
-echo "needs-cross=true" >> $GITHUB_OUTPUT
+echo "needs-cross=true" >>"$GITHUB_OUTPUT"

set-cross-dir.sh

@@ -1,4 +1,7 @@
+#!/bin/bash
+
 set -e
 set -x
+set -o pipefail
 
-echo "cross-dir=$RUNNER_TEMP" >> $GITHUB_OUTPUT
+echo "cross-dir=$RUNNER_TEMP" >>"$GITHUB_OUTPUT"

strip-binary.sh

@@ -1,20 +1,23 @@
+#!/bin/bash
+
 set -e
 set -x
+set -o pipefail
 
 TARGET=$1
 did_strip=""
 
-strip_binary () {
-    if [[ $( uname -s ) =~ "Darwin" ]]; then
+strip_binary() {
+    if [[ $(uname -s) =~ "Darwin" ]]; then
         stripped=$(
-            find "$1" -maxdepth 1 -type f -perm +111 | while read exe; do
+            find "$1" -maxdepth 1 -type f -perm +111 | while read -r exe; do
                 strip "$exe"
                 echo "stripped $exe"
             done
         )
     else
         stripped=$(
-            find "$1" -maxdepth 1 -type f -executable | while read exe; do
+            find "$1" -maxdepth 1 -type f -executable | while read -r exe; do
                 strip "$exe"
                 echo "stripped $exe"
             done