diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1db5bfd..3c59af5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,148 +1,296 @@ +# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist +# +# Copyright 2022-2024, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * builds artifacts with dist (archives, installers, hashes) +# * uploads those artifacts to temporary workflow zip +# * on success, uploads the artifacts to a GitHub Release +# +# Note that the GitHub Release will be created with a generated +# title/body based on your changelogs. + name: Release +permissions: + "contents": "write" + +# This task will run whenever you push a git tag that looks like a version +# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc. +# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where +# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION +# must be a Cargo-style SemVer Version (must have at least major.minor.patch). +# +# If PACKAGE_NAME is specified, then the announcement will be for that +# package (erroring out if it doesn't have the given version or isn't dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (dist-able) packages in the workspace with that version (this mode is +# intended for workspaces with only one dist-able package, or with all dist-able +# packages versioned/released in lockstep). +# +# If you push multiple tags at once, separate instances of this workflow will +# spin up, creating an independent announcement for each one. However, GitHub +# will hard limit this to 3 tags per commit, as it will assume more tags is a +# mistake. +# +# If there's a prerelease-style suffix to the version, then the release(s) +# will be marked as a prerelease. on: + pull_request: push: tags: - - "*" + - '**[0-9]+.[0-9]+.[0-9]+*' jobs: - build: - name: Build for ${{ matrix.name }} - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - # The runner images are chosen to be one major version behind the latest. - # The macOS runner should be x86_64 so that the binary can run on both Intel and Apple Silicon Macs. - # For example, as of Sep 2025 - # - The latest Ubuntu is 24.04, so we use ubuntu-22.04 - # - The latest macOS is 15, so we use macos-14-large - matrix: - include: - - os: ubuntu-22.04 - name: linux64 - artifact_name: target/release/ic-wasm - asset_name: ic-wasm-linux64 - - os: ubuntu-22.04 - name: linux-musl - artifact_name: target/release/ic-wasm - asset_name: ic-wasm-linux-musl - - os: macos-14-large # x86_64 build that can run on both Intel and Apple Silicon Macs - name: macos - artifact_name: target/release/ic-wasm - asset_name: ic-wasm-macos + # Run 'dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ !github.event.pull_request && github.ref_name || '' }} + tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} + publishing: ${{ !github.event.pull_request }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - uses: actions/checkout@v4 - - # Regular build for non-MUSL targets - - name: Build (non-MUSL) - if: matrix.name != 'linux-musl' - run: cargo build --release --all-features --locked - - # Native MUSL build using Alpine Docker - - name: Build (MUSL) - if: matrix.name == 'linux-musl' + with: + persist-credentials: false + submodules: recursive + - name: Install dist + # we specify bash to get pipefail; it guards against the `curl` command + # failing. otherwise `sh` won't catch that `curl` returned non-0 + shell: bash + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.30.3/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/dist + # sure would be cool if github gave us proper conditionals... + # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible + # functionality based on whether this is a pull_request, and whether it's from a fork. + # (PRs run on the *source* but secrets are usually on the *target* -- that's *good* + # but also really annoying to build CI around when it needs secrets to work right.) + - id: plan run: | - docker run --rm -v $(pwd):/src -w /src rust:alpine sh -c ' - # Install build dependencies - apk add --no-cache musl-dev binutils g++ - - # Build the project - cargo build --release --all-features --locked - ' - - - name: "Upload assets" + dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "dist ran successfully" + cat plan-dist-manifest.json + echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" uses: actions/upload-artifact@v4 with: - name: ${{ matrix.asset_name }} - path: ${{ matrix.artifact_name }} - retention-days: 3 + name: artifacts-plan-dist-manifest + path: plan-dist-manifest.json - test: - needs: build - name: Test for ${{ matrix.os }} - runs-on: ${{ matrix.os }} + # Build and packages all the platform-specific things + build-local-artifacts: + name: build-local-artifacts (${{ join(matrix.targets, ', ') }}) + # Let the initial task tell us to not run (currently very blunt) + needs: + - plan + if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} strategy: fail-fast: false - # The binaries built in the `build` job are tested on: - # - Ubuntu: latest and one major version behind latest. - # - macOS: latest and one major version behind latest. Both x86_64 and arm64 runner images. - matrix: - include: - - os: ubuntu-latest - asset_name: ic-wasm-linux64 - - os: ubuntu-22.04 - asset_name: ic-wasm-linux64 - - os: ubuntu-latest - asset_name: ic-wasm-linux-musl - - os: ubuntu-22.04 - asset_name: ic-wasm-linux-musl - - os: macos-latest-large - asset_name: ic-wasm-macos - - os: macos-latest - asset_name: ic-wasm-macos - - os: macos-14-large - asset_name: ic-wasm-macos - - os: macos-14 - asset_name: ic-wasm-macos + # Target platforms/runners are computed by dist in create-release. + # Each member of the matrix has the following arguments: + # + # - runner: the github runner + # - dist-args: cli flags to pass to dist + # - install-dist: expression to run to install dist on the runner + # + # Typically there will be: + # - 1 "global" task that builds universal installers + # - N "local" tasks that build each platform's binaries and platform-specific installers + matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }} + runs-on: ${{ matrix.runner }} + container: ${{ matrix.container && matrix.container.image || null }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json steps: - - name: Get executable - id: download + - name: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install Rust non-interactively if not already installed + if: ${{ matrix.container }} + run: | + if ! command -v cargo > /dev/null 2>&1; then + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + fi + - name: Install dist + run: ${{ matrix.install_dist.run }} + # Get the dist-manifest + - name: Fetch local artifacts uses: actions/download-artifact@v4 with: - name: ${{ matrix.asset_name }} - - - name: Test MUSL binary in Alpine - if: matrix.asset_name == 'ic-wasm-linux-musl' + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - name: Install dependencies run: | - docker run --rm -v $(pwd):/test alpine:latest sh -c ' - chmod +x /test/ic-wasm - /test/ic-wasm --version - ' - - - name: Test non-MUSL binary - if: matrix.asset_name != 'ic-wasm-linux-musl' + ${{ matrix.packages_install }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json + echo "dist ran successfully" + - id: cargo-dist + name: Post-build + # We force bash here just because github makes it really hard to get values up + # to "real" actions without writing to env-vars, and writing to env-vars has + # inconsistent syntax between shell and powershell. + shell: bash run: | - chmod +x ic-wasm - ./ic-wasm --version + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" - publish: - name: GitHub Release - runs-on: ubuntu-latest - needs: test + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-local-${{ join(matrix.targets, '_') }} + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: + needs: + - plan + - build-local-artifacts + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json steps: - - name: Get executables + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist uses: actions/download-artifact@v4 - # Download all artifacts, files will be at: - # ic-wasm-linux64/ic-wasm - # ic-wasm-linux-musl/ic-wasm - # ic-wasm-macos/ic-wasm - - - name: Prepare artifacts + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: cargo-dist + shell: bash run: | - mkdir artifacts + dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "dist ran successfully" - pushd ic-wasm-linux64 - chmod +x ic-wasm - tar -cvzf ic-wasm-x86_64-unknown-linux-gnu.tar.gz ic-wasm - mv ic-wasm ic-wasm-linux64 - mv * ../artifacts - popd + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" - pushd ic-wasm-linux-musl - chmod +x ic-wasm - tar -cvzf ic-wasm-x86_64-unknown-linux-musl.tar.gz ic-wasm - mv ic-wasm ic-wasm-linux-musl - mv * ../artifacts - popd + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-global + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + # Determines if we should publish/announce + host: + needs: + - plan + - build-local-artifacts + - build-global-artifacts + # Only run if we're "publishing", and only if plan, local and global didn't fail (skipped is fine) + if: ${{ always() && needs.plan.result == 'success' && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: host + shell: bash + run: | + dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json + echo "artifacts uploaded and released successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v4 + with: + # Overwrite the previous copy + name: artifacts-dist-manifest + path: dist-manifest.json + # Create a GitHub Release while uploading all files to it + - name: "Download GitHub Artifacts" + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: artifacts + merge-multiple: true + - name: Cleanup + run: | + # Remove the granular manifests + rm -f artifacts/*-dist-manifest.json + - name: Create GitHub Release + env: + PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}" + ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}" + ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}" + RELEASE_COMMIT: "${{ github.sha }}" + run: | + # Write and read notes from a file to avoid quoting breaking things + echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt - pushd ic-wasm-macos - chmod +x ic-wasm - tar -cvzf ic-wasm-x86_64-apple-darwin.tar.gz ic-wasm - mv ic-wasm ic-wasm-macos - mv * ../artifacts - popd + gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* - - name: Create GitHub Release - uses: softprops/action-gh-release@v2 + announce: + needs: + - plan + - host + # use "always() && ..." to allow us to wait for all publish jobs while + # still allowing individual publish jobs to skip themselves (for prereleases). + # "host" however must run to completion, no skipping allowed! + if: ${{ always() && needs.host.result == 'success' }} + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 with: - token: ${{ secrets.GITHUB_TOKEN }} - files: artifacts/* + persist-credentials: false + submodules: recursive diff --git a/Cargo.toml b/Cargo.toml index c46862e..78d9dc3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,17 +12,18 @@ categories = ["wasm"] keywords = ["internet-computer", "canister", "dfinity"] include = ["src", "Cargo.toml", "LICENSE", "README.md"] -[package.metadata.binstall] -pkg-url = "{ repo }/releases/download/{ version }/{ name }-{ target }{ archive-suffix }" -pkg-fmt = "tgz" # archive-suffix = .tar.gz - [[bin]] name = "ic-wasm" path = "src/bin/main.rs" required-features = ["exe"] [features] -check-endpoints = ["dep:anyhow", "dep:candid_parser", "dep:parse-display", "dep:serde_json"] +check-endpoints = [ + "dep:anyhow", + "dep:candid_parser", + "dep:parse-display", + "dep:serde_json", +] default = ["check-endpoints", "exe", "wasm-opt"] exe = ["dep:anyhow", "dep:clap", "dep:serde"] wasm-opt = ["dep:wasm-opt", "dep:tempfile"] @@ -48,3 +49,8 @@ wasmparser = "0.223.0" [dev-dependencies] assert_cmd = "2" + +# The profile that 'dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/dist-workspace.toml b/dist-workspace.toml new file mode 100644 index 0000000..cafc5d9 --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,16 @@ +[workspace] +members = ["cargo:."] + +# Config for 'dist' +[dist] +# The preferred dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.30.3" +# CI backends to support +ci = "github" +# The installers to generate for each app +installers = [] +# Target platforms to build apps for (Rust target-triple syntax) +targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-pc-windows-msvc"] + +[dist.github-custom-runners] +x86_64-unknown-linux-musl = "ubuntu-22.04-arm" # force dist build to use cargo-zigbuild on this target