Add Changes.md entry for 0.0.12

Bump actions/cache to v4

.github/workflows/lint.yml

@@ -10,7 +10,7 @@ jobs:
     name: Check that code is lint clean using precious
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Configure Git
         run: |
           git config --global user.email "jdoe@example.com"

.github/workflows/test.yml

@@ -35,6 +35,16 @@ jobs:
             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"
+            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-arm
             os: ubuntu-20.04
             target: arm-unknown-linux-musleabi
@@ -47,38 +57,14 @@ jobs:
             os: ubuntu-20.04
             target: i586-unknown-linux-musl
             expect_file_re: "ELF.+80386"
-            expect_cross: "--no-expect-cross"
-            expect_stripped: "--expect-stripped"
-            can_test: true
-
-          - platform_name: Linux-mips
-            os: ubuntu-20.04
-            target: mips-unknown-linux-musl
-            expect_file_re: "MIPS32.+mips-"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
             can_test: true
 
-          - platform_name: Linux-mipsel
+          - platform_name: Linux-i686
             os: ubuntu-20.04
-            target: mipsel-unknown-linux-musl
-            expect_file_re: "MIPS32.+mipsel-"
-            expect_cross: "--expect-cross"
-            expect_stripped: "--no-expect-stripped"
-            can_test: true
-
-          - platform_name: Linux-mips64
-            os: ubuntu-20.04
-            target: mips64-unknown-linux-muslabi64
-            expect_file_re: "MIPS64"
-            expect_cross: "--expect-cross"
-            expect_stripped: "--no-expect-stripped"
-            can_test: true
-
-          - platform_name: Linux-mips64el
-            os: ubuntu-20.04
-            target: mips64el-unknown-linux-muslabi64
-            expect_file_re: "MIPS64"
+            target: i686-unknown-linux-musl
+            expect_file_re: "ELF.+80386"
             expect_cross: "--expect-cross"
             expect_stripped: "--no-expect-stripped"
             can_test: true
@@ -173,7 +159,7 @@ jobs:
     runs-on: ${{ matrix.platform.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Copy test project to root
         shell: bash
         run: |
@@ -183,6 +169,7 @@ jobs:
         uses: ./
         with:
           command: both
+          cross-version: ${{ matrix.platform.cross-version }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
@@ -190,6 +177,7 @@ jobs:
         uses: ./
         with:
           command: test
+          cross-version: ${{ matrix.platform.cross-version }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
@@ -197,6 +185,7 @@ jobs:
         uses: ./
         with:
           command: build
+          cross-version: ${{ matrix.platform.cross-version }}
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           strip: true
@@ -204,6 +193,7 @@ jobs:
         uses: ./
         with:
           command: build
+          cross-version: ${{ matrix.platform.cross-version }}
           working-directory: subcrate
           target: ${{ matrix.platform.target }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -214,5 +204,6 @@ jobs:
           tests/check-binary.pl \
               --target "${{ matrix.platform.target }}" \
               --expect-file-re "${{ matrix.platform.expect_file_re }}" \
+              --expect-cross-version "${{ matrix.platform.expect_cross_version }}" \
               ${{ matrix.platform.expect_cross }} \
               ${{ matrix.platform.expect_stripped }}

Changes.md

@@ -1,3 +1,21 @@
+## 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.
+
+## 0.0.11 - 2023-12-17
+
+- Use `cross` when compiling for 32-bit Linux targets. While in theory this should work without
+  `cross`, compiling `openssl` with the `vendored` feature fails when we run
+  `cargo build --target i686-unknown-linux-musl`.
+
+## 0.0.10 - 2023-12-10
+
+- Fixed handling of crates with multiple binaries. Attempting to strip binaries for such a crate
+  caused the build to fail. Reported by Tomaž Hribernik. GH #8
+- Added a new `cross-version` parameter. This can be specified to make this action use a specific
+  version of `cross`. If this is not specified, the latest version will be used.
+
 ## 0.0.9 - 2023-09-10
 
 - Added a `working-directory` parameter. By default this is the current directory (`.`) but you can

README.md

@@ -55,19 +55,20 @@ 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 fails 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 listed 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 binary will be stripped if possible. This is only possible for binaries which weren't cross-compiled. |
+| 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. |
 
 ## How it Works
 
-Under the hood, this action will compile your binary with either `cargo` or `cross`, depending on
+Under the hood, this action will compile your binaries with either `cargo` or `cross`, depending on
 the host machine and target. For Linux builds, it will always use `cross` except for builds
 targeting an x86 architecture like `x86_64` or `i686`.
 
@@ -81,7 +82,7 @@ build `cross`.
 When compiling on Windows, it will do so in a Powershell environment, which can matter in some
 corner cases, like compiling the `openssl` crate with the `vendored` feature.
 
-Finally, it will run `strip` to strip the binary if the `strip` parameter is true. This is only
+Finally, it will run `strip` to strip the binaries if the `strip` parameter is true. This is only
 possible for builds that are not done via `cross`. In addition, Windows builds for `aarch64` cannot
 be stripped either.
 

action.yml

@@ -32,6 +32,10 @@ inputs:
   strip:
     description: Strip the compiled binary
     default: false
+  cross-version:
+    description: |
+      The version of cross to use. If not specified, then the latest version
+      will be used.
 runs:
   using: composite
   steps:
@@ -47,10 +51,10 @@ runs:
       with:
         targets: ${{ inputs.target }}
         toolchain: ${{ inputs.toolchain }}
-    - name: Determine latest cross version
-      id: determine-latest-cross-version
+    - name: Determine cross version
+      id: determine-cross-version
       shell: bash
-      run: determine-latest-cross-version.sh
+      run: determine-cross-version.sh "${{ inputs.cross-version }}"
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' }}
@@ -63,14 +67,14 @@ runs:
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' }}
     - name: Cache cross
       id: cache-cross
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.set-cross-dir.outputs.cross-dir }}/cross
-        key: ${{ runner.os }}-${{ steps.determine-latest-cross-version.outputs.cross-version }}
+        key: ${{ runner.os }}-${{ steps.determine-cross-version.outputs.cross-version }}
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' }}
     - name: Install cross if cross-compiling (*nix)
       shell: bash
-      run: install-cross-nix.sh ${{ steps.set-cross-dir.outputs.cross-dir }}
+      run: install-cross-nix.sh ${{ steps.set-cross-dir.outputs.cross-dir }} ${{ steps.determine-cross-version.outputs.cross-version }}
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'true' && steps.cache-cross.outputs.cache-hit != 'true' }}
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}

determine-cross-version.sh

@@ -0,0 +1,15 @@
+set -e
+set -x
+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")
+fi
+
+echo "cross-version=$VERSION" >> $GITHUB_OUTPUT

determine-latest-cross-version.sh

@@ -1,11 +0,0 @@
-set -e
-set -x
-set -o pipefail
-
-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")
-
-echo "cross-version=$VERSION" >> $GITHUB_OUTPUT

install-cross-nix.sh

@@ -3,9 +3,16 @@ set -x
 set -o pipefail
 
 CROSS_DIR="$1"
+VERSION="$2"
+
+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 |
     sh
-./ubi --project cross-rs/cross --matching musl --in .
+./ubi --project cross-rs/cross --matching musl --in . $VERSION_ARGS

set-cross-compile.sh

@@ -10,7 +10,11 @@ if uname -a | grep --quiet --extended-regexp -i "darwin|msys|windows"; then
     exit 0
 fi
 
-if echo "$TARGET" | grep --quiet --extended-regexp -i '(x86_64|586|686).+linux-(gnu|musl)'; then
+# On Linux, we should be able to cross-compile to i586 and i686, but in
+# practice this fails with some crates, notably openssl with the "vendored"
+# 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
     exit 0
 fi

strip-binary.sh

@@ -2,20 +2,29 @@ set -e
 set -x
 
 TARGET=$1
-stripped=""
+did_strip=""
 
 strip_binary () {
     if [[ $( uname -s ) =~ "Darwin" ]]; then
-        EXE=$( find "$1" -maxdepth 1 -type f -perm +111 )
+        stripped=$(
+            find "$1" -maxdepth 1 -type f -perm +111 | while read exe; do
+                strip "$exe"
+                echo "stripped $exe"
+            done
+        )
     else
-        EXE=$( find "$1" -maxdepth 1 -type f -executable )
+        stripped=$(
+            find "$1" -maxdepth 1 -type f -executable | while read exe; do
+                strip "$exe"
+                echo "stripped $exe"
+            done
+        )
     fi
 
-    if [ -z "$EXE" ]; then
-        echo "Could not find a binary to strip in $1"
+    if [ -z "$stripped" ]; then
+        echo "Could not find any binaries to strip in $1"
     else
-        strip "$EXE"
-        stripped="$EXE"
+        did_strip="true"
     fi
 }
 
@@ -27,7 +36,7 @@ for type in debug release; do
     fi
 done
 
-if [ -z "$stripped" ]; then
+if [ -z "$did_strip" ]; then
     echo "No binaries were stripped"
     exit 1
 fi

test-project/Cargo.toml

@@ -3,4 +3,25 @@ name = "test-project"
 version = "0.1.0"
 edition = "2021"
 
-[dependencies]
+# For testing it would be nice to create a binary with spaces in the name, but
+# right now the `name` value must be a valid crate name, and there's no
+# separate setting for the compiled executable's name. See
+# https://github.com/rust-lang/cargo/issues/9778.
+[[bin]]
+name = "bin1"
+path = "src/bin1.rs"
+
+[[bin]]
+name = "bin2"
+path = "src/bin2.rs"
+
+# workaround for https://github.com/cross-rs/cross/issues/1345
+[package.metadata.cross.target.x86_64-unknown-netbsd]
+pre-build = [
+    "mkdir -p /tmp/netbsd",
+    "curl https://cdn.netbsd.org/pub/NetBSD/NetBSD-9.2/amd64/binary/sets/base.tar.xz -O",
+    "tar -C /tmp/netbsd -xJf base.tar.xz",
+    "cp /tmp/netbsd/usr/lib/libexecinfo.so /usr/local/x86_64-unknown-netbsd/lib",
+    "rm base.tar.xz",
+    "rm -rf /tmp/netbsd",
+]

test-project/src/bin2.rs

@@ -0,0 +1,11 @@
+fn main() {
+    println!("Hello, world!");
+}
+
+#[cfg(test)]
+mod test {
+    #[test]
+    fn test_something() {
+        assert_eq!(1, 1);
+    }
+}

test-project/subcrate/Cargo.toml

@@ -3,6 +3,13 @@ name = "subcrate"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
+# workaround for https://github.com/cross-rs/cross/issues/1345
+[package.metadata.cross.target.x86_64-unknown-netbsd]
+pre-build = [
+    "mkdir -p /tmp/netbsd",
+    "curl https://cdn.netbsd.org/pub/NetBSD/NetBSD-9.2/amd64/binary/sets/base.tar.xz -O",
+    "tar -C /tmp/netbsd -xJf base.tar.xz",
+    "cp /tmp/netbsd/usr/lib/libexecinfo.so /usr/local/x86_64-unknown-netbsd/lib",
+    "rm base.tar.xz",
+    "rm -rf /tmp/netbsd",
+]

tests/check-binary.pl

@@ -19,20 +19,27 @@ use Test::More;
 sub main {
     my $target;
     my $expect_cross;
+    my $expect_cross_version;
     my $expect_file_re;
     my $expect_stripped;
 
     GetOptions(
-        'target=s'         => \$target,
-        'expect-file-re=s' => \$expect_file_re,
-        'expect-cross!'    => \$expect_cross,
-        'expect-stripped!' => \$expect_stripped,
+        'target=s'               => \$target,
+        'expect-file-re=s'       => \$expect_file_re,
+        'expect-cross!'          => \$expect_cross,
+        'expect-cross-version=s' => \$expect_cross_version,
+        'expect-stripped!'       => \$expect_stripped,
     );
 
-    check_cross( path( $ENV{RUNNER_TEMP} ), $expect_cross );
+    check_cross(
+        path( $ENV{RUNNER_TEMP} ),
+        $expect_cross,
+        $expect_cross_version
+    );
 
     for my $bin (
-        path( qw( . target ),          $target, qw( debug test-project ) ),
+        path( qw( . target ),          $target, qw( debug bin1 ) ),
+        path( qw( . target ),          $target, qw( debug bin2 ) ),
         path( qw( . subcrate target ), $target, qw( debug subcrate ) )
     ) {
         check_binary( $bin, $expect_file_re, $expect_stripped );
@@ -41,10 +48,17 @@ sub main {
     done_testing();
 }
 
-sub check_cross ( $bin_dir, $expect_cross ) {
+sub check_cross ( $bin_dir, $expect_cross, $expect_cross_version ) {
     my $cross = $bin_dir->child('cross');
     if ($expect_cross) {
         ok( $cross->is_file && -x $cross, 'found `cross` in $PATH' );
+        if ($expect_cross_version) {
+            my $version = capturex( $cross, '--version' );
+            like(
+                $version, qr/\Q$expect_cross_version/,
+                'cross version matches expected version'
+            );
+        }
     }
     else {
         ok( !$cross->exists, 'did not find `cross` in $PATH' );

tests/check-binary.sh

@@ -1,49 +0,0 @@
-set -e
-set -x
-
-TARGET=$1
-EXPECT_CROSS=$2
-EXPECT_FILE_RE=$3
-EXPECT_STRIPPED=$4
-
-if [ "$EXPECT_CROSS" == "true" ]; then
-    if [ ! -f "$RUNNER_TEMP/cross" ]; then
-        echo "Could not find cross in path: $PATH"
-        exit 1
-    fi
-else
-    if [ -f "$RUNNER_TEMP/cross" ]; then
-        echo "Found cross in path: $PATH"
-        exit 1
-    fi
-fi
-
-FILE=$(file --brief ./target/$TARGET/debug/test-project)
-if [[ "$FILE" =~ $EXPECT_FILE_RE ]]; then
-    echo "file output matches $EXPECT_FILE_RE"
-else
-    echo "file output does not match $EXPECT_FILE_RE"
-    exit 2
-fi
-
-if [[ $( uname -s ) =~ "Darwin" ]]; then
-    # File on macOS doesn't report whether the binary is stripped or not.
-    exit 0
-fi
-
-if [[ "$FILE" =~ "not stripped" ]]; then
-    echo "binary was not stripped"
-    GOT_STRIPPED="false"
-elif [[ "$FILE" =~ "stripped" ]]; then
-    echo "binary was stripped"
-    GOT_STRIPPED="true"
-else
-    # On Windows the aarch64 binary's file info doesn't include the word
-    # "stripped" at all.
-    echo "binary was not stripped"
-    GOT_STRIPPED="false"
-fi
-
-if [ "$EXPECT_STRIPPED" != "$GOT_STRIPPED" ]; then
-    exit 3
-fi