From 66ed3b1d671ff34a462b978e46da85c8267d4598 Mon Sep 17 00:00:00 2001 From: Caleb Smith Date: Wed, 3 Jul 2024 16:34:13 -0500 Subject: [PATCH] Experiment with `cargo dist` for releases --- .github/workflows/release.yml | 363 ++++++++++++++++++++++++++-------- Cargo.toml | 27 +++ crates/uk-editor/Cargo.toml | 64 +++--- crates/uk-editor/wix/main.wxs | 237 ++++++++++++++++++++++ wix/main.wxs | 228 +++++++++++++++++++++ 5 files changed, 814 insertions(+), 105 deletions(-) create mode 100644 crates/uk-editor/wix/main.wxs create mode 100644 wix/main.wxs diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 127bbfe9..29f88803 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,77 +1,286 @@ -on: - release: - types: [created] - workflow_dispatch: {} - -jobs: - release: - name: Release ${{ matrix.platform.name }} - runs-on: ${{ matrix.platform.os }} - strategy: - matrix: - platform: - - os: ubuntu-latest - name: linux - ext: ~ - - os: macos-14 - name: macos - ext: ~ - - os: windows-latest - name: windows - ext: .exe - - os: ubuntu-20.04 - name: steamdeck - ext: ~ - steps: - - uses: actions/checkout@master - - name: Cache crates - uses: actions/cache@v3 - with: - key: ${{ matrix.platform.os }}-cargo-cache - path: | - ~/.cargo/registry - ~/.cargo/git - ./target - - uses: SebRollen/toml-action@v1.0.1 - id: read_toml - name: Get version - with: - file: 'Cargo.toml' - field: 'workspace.package.version' - - name: Install GTK - run: sudo apt update && sudo apt install libgtk-3-dev - if: contains(matrix.platform.os, 'ubuntu') - - name: Install Rust - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - - name: Build - run: cargo build --release - env: - UPDATE_PLATFORM: ${{ matrix.platform.name }} - MACOSX_DEPLOYMENT_TARGET: 11.0 - - name: UPX compress binary - uses: crazy-max/ghaction-upx@v2.2.0 - if: contains(matrix.platform.os, 'ubuntu') - with: - version: v4.0.2 - args: --best --lzma - files: ./target/release/ukmm${{ matrix.platform.ext }} - - name: Archive release - uses: thedoctor0/zip-release@main - with: - type: zip - filename: ukmm-v${{ steps.read_toml.outputs.value }}-${{ matrix.platform.name }}.zip - path: ukmm${{ matrix.platform.ext }} - directory: target/release - - name: Upload release assets - uses: AButler/upload-release-assets@v2.0 - with: - files: ./target/release/*.zip - release-tag: 'v${{ steps.read_toml.outputs.value }}' - repo-token: ${{ secrets.GITHUB_TOKEN }} - env: - CARGO_PROFILE_RELEASE_CODEGEN_UNITS: 1 - CARGO_PROFILE_RELEASE_LTO: "true" - RUSTFLAGS: "-C link-arg=-s" - OPENSSL_STATIC: 1 +# 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 cargo-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 cargo-dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (cargo-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: + # Run 'cargo dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: "ubuntu-20.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 + with: + submodules: recursive + - name: Install cargo-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.17.0/cargo-dist-installer.sh | sh" + - name: Cache cargo-dist + uses: actions/upload-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/cargo-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: | + cargo dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "cargo 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: artifacts-plan-dist-manifest + path: plan-dist-manifest.json + + # 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 + # Target platforms/runners are computed by cargo-dist in create-release. + # Each member of the matrix has the following arguments: + # + # - runner: the github runner + # - dist-args: cli flags to pass to cargo dist + # - install-dist: expression to run to install cargo-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 }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json + steps: + - name: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: swatinem/rust-cache@v2 + with: + key: ${{ join(matrix.targets, '-') }} + cache-provider: ${{ matrix.cache_provider }} + - name: Install cargo-dist + run: ${{ matrix.install_dist }} + # Get the dist-manifest + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + cargo dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json + echo "cargo 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: | + # 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" + + 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-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cached cargo-dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/cargo-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: | + cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "cargo dist ran successfully" + + # 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" + + 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 local and global didn't fail (skipped is fine) + if: ${{ always() && 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-20.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cached cargo-dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/cargo-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: | + cargo 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 + + gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* + + 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-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive diff --git a/Cargo.toml b/Cargo.toml index 98d1b2ba..09342864 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,6 +7,12 @@ edition = "2021" license = "GPL-3.0-or-later" version = { workspace = true } +[package.metadata.wix] +upgrade-guid = "0EC50392-193E-4A2B-9322-3CF045D8FCAE" +path-guid = "BC0A4F00-5469-4677-B5F4-61A17A215A27" +license = false +eula = false + [dependencies] anyhow = { workspace = true } anyhow_ext = { workspace = true } @@ -107,3 +113,24 @@ thiserror = "1.0.38" typetag = "0.2.1" zip = { version = "0.6.2", default-features = false } zstd = { version = "0.13.1", features = ["experimental"] } + +# Config for 'cargo dist' +[workspace.metadata.dist] +# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.17.0" +# CI backends to support +ci = "github" +# The installers to generate for each app +installers = ["shell", "powershell", "msi"] +# Target platforms to build apps for (Rust target-triple syntax) +targets = ["x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"] +# Publish jobs to run in CI +pr-run-mode = "plan" +# Whether to install an updater program +install-updater = true + +# The profile that 'cargo dist' will build with +[profile.dist] +inherits = "release" +lto = true +codegen-units = 2 diff --git a/crates/uk-editor/Cargo.toml b/crates/uk-editor/Cargo.toml index f220180f..1d66f7cb 100644 --- a/crates/uk-editor/Cargo.toml +++ b/crates/uk-editor/Cargo.toml @@ -1,28 +1,36 @@ -[package] -name = "uk-editor" -edition = "2021" -version.workspace = true - -[dependencies] -anyhow = { workspace = true } -eframe = { workspace = true, features = ["glow"] } -flume = { workspace = true } -fs-err = { workspace = true } -jwalk = { workspace = true } -minicbor-ser = { workspace = true } -parking_lot = { workspace = true } -path-slash = { workspace = true } -rfd = { workspace = true } -rayon = { workspace = true } -roead = { workspace = true, features = ["with-serde", "yaml"] } -serde = { workspace = true } -serde_json = { workspace = true } -serde_yaml = { workspace = true } - -uk-content = { path = "../uk-content", features = ["ui"] } -uk-manager = { path ="../uk-manager" } -uk-mod = { path = "../uk-mod" } -uk-ui = { path = "../uk-ui" } -uk-ui-derive = { path = "../uk-ui-derive" } -uk-util = { path = "../uk-util" } -ron = "0.8.0" +[package] +name = "uk-editor" +authors = ["Caleb Smith "] +edition = "2021" +publish = false +version.workspace = true + +[package.metadata.wix] +upgrade-guid = "53241AAE-2269-4EA6-96E9-E17D464137DA" +path-guid = "E0CA8178-5543-41CD-BCA2-A36FDD406020" +license = false +eula = false + +[dependencies] +anyhow = { workspace = true } +eframe = { workspace = true, features = ["glow"] } +flume = { workspace = true } +fs-err = { workspace = true } +jwalk = { workspace = true } +minicbor-ser = { workspace = true } +parking_lot = { workspace = true } +path-slash = { workspace = true } +rfd = { workspace = true } +rayon = { workspace = true } +roead = { workspace = true, features = ["with-serde", "yaml"] } +serde = { workspace = true } +serde_json = { workspace = true } +serde_yaml = { workspace = true } + +uk-content = { path = "../uk-content", features = ["ui"] } +uk-manager = { path ="../uk-manager" } +uk-mod = { path = "../uk-mod" } +uk-ui = { path = "../uk-ui" } +uk-ui-derive = { path = "../uk-ui-derive" } +uk-util = { path = "../uk-util" } +ron = "0.8.0" diff --git a/crates/uk-editor/wix/main.wxs b/crates/uk-editor/wix/main.wxs new file mode 100644 index 00000000..f673b296 --- /dev/null +++ b/crates/uk-editor/wix/main.wxs @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + 1 + + + + + + + + + + + + + + + + + + diff --git a/wix/main.wxs b/wix/main.wxs new file mode 100644 index 00000000..156f2df1 --- /dev/null +++ b/wix/main.wxs @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + 1 + + + + + + + + + + + + + + + + + +