From 03039fc9254967c861f0647f4d06137c2c06db4a Mon Sep 17 00:00:00 2001 From: Miles Johnson Date: Tue, 29 Aug 2023 10:33:44 -0700 Subject: [PATCH] ci: Add cargo-dist for publishing. (#16) --- .github/workflows/release.yml | 168 ++++++++++++++++++++++++++++++++++ Cargo.toml | 22 +++++ crates/cli/Cargo.toml | 5 +- 3 files changed, 194 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..71f5ca6 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,168 @@ +# Copyright 2022-2023, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * creates a Github Release™ and fills in its text +# * builds artifacts with cargo-dist (executable-zips, installers) +# * uploads those artifacts to the Github Release™ +# +# Note that the Github Release™ will be created before the artifacts, +# so there will be a few minutes where the release has no artifacts +# and then they will slowly trickle in, possibly failing. To make +# this more pleasant we mark the release as a "draft" until all +# artifacts have been successfully uploaded. This allows you to +# choose what to do with partial successes and avoids spamming +# anyone with notifications before the release is actually ready. +name: Release + +permissions: + contents: write + +# This task will run whenever you push a git tag that looks like a version +# like "v1", "v1.2.0", "v0.1.0-prerelease01", "my-app-v1.0.0", etc. +# The version will be roughly parsed as ({PACKAGE_NAME}-)?v{VERSION}, where +# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION +# must be a Cargo-style SemVer Version. +# +# If PACKAGE_NAME is specified, then we will create a Github Release™ 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 we will create a Github Release™ for all +# (cargo-dist-able) packages in the workspace with that version (this is 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 Github Release™ for each one. +# +# If there's a prerelease-style suffix to the version then the Github Release™ +# will be marked as a prerelease. +on: + push: + tags: + - '*-?v[0-9]+*' + +jobs: + # Create the Github Release™ so the packages have something to be uploaded to + create-release: + runs-on: ubuntu-latest + outputs: + has-releases: ${{ steps.create-release.outputs.has-releases }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v3 + with: + submodules: recursive + - name: Install cargo-dist + run: + "curl --proto '=https' --tlsv1.2 -LsSf + https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.sh | + sh" + - id: create-release + run: | + cargo dist plan --tag=${{ github.ref_name }} --output-format=json > dist-manifest.json + echo "dist plan ran successfully" + cat dist-manifest.json + + # Create the Github Release™ based on what cargo-dist thinks it should be + ANNOUNCEMENT_TITLE=$(jq --raw-output ".announcement_title" dist-manifest.json) + IS_PRERELEASE=$(jq --raw-output ".announcement_is_prerelease" dist-manifest.json) + jq --raw-output ".announcement_github_body" dist-manifest.json > new_dist_announcement.md + gh release create ${{ github.ref_name }} --draft --prerelease="$IS_PRERELEASE" --title="$ANNOUNCEMENT_TITLE" --notes-file=new_dist_announcement.md + echo "created announcement!" + + # Upload the manifest to the Github Release™ + gh release upload ${{ github.ref_name }} dist-manifest.json + echo "uploaded manifest!" + + # Disable all the upload-artifacts tasks if we have no actual releases + HAS_RELEASES=$(jq --raw-output ".releases != null" dist-manifest.json) + echo "has-releases=$HAS_RELEASES" >> "$GITHUB_OUTPUT" + + # Build and packages all the things + upload-artifacts: + # Let the initial task tell us to not run (currently very blunt) + needs: create-release + if: ${{ needs.create-release.outputs.has-releases == 'true' }} + strategy: + fail-fast: false + matrix: + # For these target platforms + include: + - os: 'ubuntu-20.04' + dist-args: '--artifacts=global' + install-dist: + "curl --proto '=https' --tlsv1.2 -LsSf + https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.sh + | sh" + - os: 'macos-11' + dist-args: '--artifacts=local --target=aarch64-apple-darwin' + install-dist: + "curl --proto '=https' --tlsv1.2 -LsSf + https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.sh + | sh" + - os: 'macos-11' + dist-args: '--artifacts=local --target=x86_64-apple-darwin' + install-dist: + "curl --proto '=https' --tlsv1.2 -LsSf + https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.sh + | sh" + - os: 'windows-2019' + dist-args: '--artifacts=local --target=x86_64-pc-windows-msvc' + install-dist: + 'irm https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.ps1 + | iex' + - os: 'ubuntu-20.04' + dist-args: '--artifacts=local --target=x86_64-unknown-linux-gnu' + install-dist: + "curl --proto '=https' --tlsv1.2 -LsSf + https://github.com/axodotdev/cargo-dist/releases/download/v0.1.0/cargo-dist-installer.sh + | sh" + + runs-on: ${{ matrix.os }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v3 + with: + submodules: recursive + - name: Install cargo-dist + run: ${{ matrix.install-dist }} + - name: Run cargo-dist + # This logic is a bit janky because it's trying to be a polyglot between + # powershell and bash since this will run on windows, macos, and linux! + # The two platforms don't agree on how to talk about env vars but they + # do agree on 'cat' and '$()' so we use that to marshal values between commands. + run: | + # Actually do builds and make zips and whatnot + cargo dist build --tag=${{ github.ref_name }} --output-format=json ${{ matrix.dist-args }} > dist-manifest.json + echo "dist ran successfully" + cat dist-manifest.json + + # Parse out what we just built and upload it to the Github Release™ + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json > uploads.txt + echo "uploading..." + cat uploads.txt + gh release upload ${{ github.ref_name }} $(cat uploads.txt) + echo "uploaded!" + + # Mark the Github Release™ as a non-draft now that everything has succeeded! + publish-release: + # Only run after all the other tasks, but it's ok if upload-artifacts was skipped + needs: [create-release, upload-artifacts] + if: + ${{ always() && needs.create-release.result == 'success' && (needs.upload-artifacts.result == + 'skipped' || needs.upload-artifacts.result == 'success') }} + runs-on: ubuntu-latest + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v3 + with: + submodules: recursive + - name: mark release as non-draft + run: | + gh release edit ${{ github.ref_name }} --draft=false diff --git a/Cargo.toml b/Cargo.toml index 9d18816..61a0f80 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -35,3 +35,25 @@ thiserror = "1.0.47" tokio = { version = "1.32.0", features = ["full", "tracing"] } tracing = "0.1.37" url = { version = "2.4.0", features = ["serde"] } + +# Config for 'cargo dist' +[workspace.metadata.dist] +# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.1.0" +# CI backends to support (see 'cargo dist generate-ci') +ci = ["github"] +# The installers to generate for each app +installers = ["shell", "powershell"] +install-path = "~/.espresso/bin" +# Target platforms to build apps for (Rust target-triple syntax) +targets = [ + "x86_64-unknown-linux-gnu", + "x86_64-apple-darwin", + "x86_64-pc-windows-msvc", + "aarch64-apple-darwin", +] + +# The profile that 'cargo dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/crates/cli/Cargo.toml b/crates/cli/Cargo.toml index 90b2885..1a72e6d 100644 --- a/crates/cli/Cargo.toml +++ b/crates/cli/Cargo.toml @@ -1,8 +1,11 @@ [package] name = "espresso_cli" -version = "0.1.0" +version = "0.0.1" edition = "2021" license = "MIT" +description = "Next-generation JavaScript package manager." +homepage = "https://espresso.build" +repository = "https://github.com/moonrepo/espresso" [[bin]] name = "espm"