ci: Distribute compiled binary files via GitHub release

[taiki-e]

If you install locally, I basically recommend using cargo install, but given that one of cargo-hack's main purposes is to use it in CI, it makes sense to distribute the compiled binary files.

[taiki-e]

UPDATE: See #91 for the currently recommended install script.

To install latest release:

# get latest release and host toolchain
version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
host=$(rustc -Vv | grep host | sed 's/host: //')

# linux/macos
curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf -

# windows
curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
7z x cargo-hack.zip

[taiki-e]

bors r+

[bors]

Build succeeded:

• ci

[jhpratt]

I will say, we think alike. I've been contemplating whether to file a PR for a couple days for this exact thing 😁

[jhpratt]

For those (like myself) looking for a single script to download it, I just added some conditionals to the above.

version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
host=$(rustc -Vv | grep host | sed 's/host: //')

if [ $host = 'x86_64-pc-windows-msvc' ]; then
    curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
    7z x cargo-hack.zip
elif [ $host = 'x86_64-apple-darwin' ] || [ $host = 'x86_64-unknown-linux-gnu' ]; then
    curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf -
else
    echo "unsupported operating system"
    exit 1
fi

Use freely, of course.

[taiki-e]

@jhpratt Thanks, that script is really useful:)

[taiki-e]

FWIW, if don't care about the exact name of the toolchain (usually there is no problem), using [[ ... ]] instead of [ ... ] makes it a bit simpler:

- if [ $host = 'x86_64-pc-windows-msvc' ]; then
+ if [[ $host =~ windows ]]; then
      curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
      7z x cargo-hack.zip
- elif [ $host = 'x86_64-apple-darwin' ] || [ $host = 'x86_64-unknown-linux-gnu' ]; then
+ elif [[ $host =~ darwin|linux ]]; then

[jhpratt]

That would definitely make things simpler.

I'm currently looking into how I can still add cargo-hack to $PATH for GitHub Actions. For obvious reasons I'd prefer to avoid adding the current directory to the path. I'm honestly not too familiar with what the idiomatic thing to do is if you have any suggestions?

[jhpratt]

And completely unrelated to my previous comment, it might be worth stripping the binary before bundling it up. In my experience this typically reduces binary size by about two thirds.

[taiki-e]

I'm currently looking into how I can still add cargo-hack to $PATH for GitHub Actions. For obvious reasons I'd prefer to avoid adding the current directory to the path. I'm honestly not too familiar with what the idiomatic thing to do is if you have any suggestions?

I don't know if that's the idiomatic way, but I think creating a new directory and adding that directory to $PATH is an easy way. Something like the following:

mkdir ci-bin
mv cargo-hack ci-bin/
echo "$(pwd)/ci-bin" >> "${GITHUB_PATH}"

it might be worth stripping the binary before bundling it up. In my experience this typically reduces binary size by about two thirds.

I think that's definitely a good idea, I'll try that.

EDIT: filed #90

[jhpratt]

I've no idea if you're familiar with the way the PATH env var works in Windows, but I certainly don't. Just reporting that doing the following fails on CI (I use Linux personally, and my household doesn't have any Windows machines).

- name: Install cargo-hack
  shell: bash
  run: |
    version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
    host=$(rustc -Vv | grep host | sed 's/host: //')

    if [[ $host =~ windows ]]; then
        curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
        7z x cargo-hack.zip
    elif [[ $host =~ darwin|linux ]]; then
        curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf -
    else
        echo "unsupported operating system"
        exit 1
    fi

    mkdir __cargo_hack_bin
    mv cargo-hack __cargo_hack_bin
    echo "$(pwd)/__cargo_hack_bin" >> $GITHUB_PATH

And I see that you've already implemented stripping, but given that the download is <1 second on CI in the previous link, it turns out that minor optimization will probably have an extremely small effect.

[taiki-e]

I've no idea if you're familiar with the way the PATH env var works in Windows, but I certainly don't. Just reporting that doing the following fails on CI (I use Linux personally, and my household doesn't have any Windows machines).

Hmm, it's odd that $GITHUB_PATH doesn't work on windows. (I thought it is the formal way to add path...)
I think the way of moving a binary to a directory that is already in $PATH should probably work:

mv cargo-hack $HOME/.cargo/bin/

[taiki-e]

Hmm, it's odd that $GITHUB_PATH doesn't work on windows. (I thought it is the formal way to add path...)

Oh, this seems to be because the Unix style absolute path (\c\...) returned by bash's pwd is not considered a valid path of Windows. So the following patches work.

          7z x cargo-hack.zip
+         echo "$(pwd)/__cargo_hack_bin" | sed 's/^\///' | sed 's/\//:\\/' >> $GITHUB_PATH
      elif [[ $host =~ darwin|linux ]]; then
          curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf -
+         echo "$(pwd)/__cargo_hack_bin" >> $GITHUB_PATH
      else

      mkdir __cargo_hack_bin
      mv cargo-hack __cargo_hack_bin
-     echo "$(pwd)/__cargo_hack_bin" >> $GITHUB_PATH

However, the way mentioned in my comments above is simpler.

version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
host=$(rustc -Vv | grep host | sed 's/host: //')

if [[ $host =~ windows ]]; then
  curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
  7z x cargo-hack.zip
elif [[ $host =~ darwin|linux ]]; then
  curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf -
else
  echo "unsupported operating system"
  exit 1
fi

mv cargo-hack $HOME/.cargo/bin/

[jhpratt]

That's some odd behavior. I pulled the mv behavior into the extraction, but that's just personal preference. I can confirm that this works as expected on CI.

version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
host=$(rustc -Vv | grep host | sed 's/host: //')

if [[ $host =~ windows ]]; then
    curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.zip -o cargo-hack.zip
    7z x cargo-hack.zip -o~/.cargo/bin
elif [[ $host =~ darwin|linux ]]; then
    curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-${host}.tar.gz | tar xzf - -C ~/.cargo/bin
else
    echo "unsupported operating system"
    exit 1
fi

[taiki-e]

Hmm, maybe it is better not to include the version number in the release binary. cross-rs/cross#457
That allows installing cargo-hack with one command if you know the host os.
before(current):

version=$(curl -LsSf https://api.github.com/repos/taiki-e/cargo-hack/releases/latest | jq -r '.name')
curl -LsSf https://github.com/taiki-e/cargo-hack/releases/download/v${version}/cargo-hack-v${version}-x86_64-unknown-linux-gnu.tar.gz | tar xzf - -C ~/.cargo/bin

after:

curl -LsSf https://github.com/taiki-e/cargo-hack/releases/latest/download/cargo-hack-x86_64-unknown-linux-gnu.tar.gz | tar xzf - -C ~/.cargo/bin

That said, this will break the CI that depends on the current URL. However, this issue can be avoided by distributing under both names until the next major version (0.5).

UPDATE: filed #91 and released in 0.4.4