From cc4ca29647c97267c80523f25f069f8bcfe89960 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Mon, 9 Oct 2023 16:15:50 -0400 Subject: [PATCH] Update Cargo.toml files to use workspace metadata --- .github/workflows/release.yml | 191 ++++++++++++++++++ Cargo.toml | 18 ++ crates/gourgeist/Cargo.toml | 12 +- crates/gourgeist/{Readme.md => README.md} | 0 crates/install-wheel-rs/Cargo.toml | 11 +- .../pep440-rs/{Changelog.md => CHANGELOG.md} | 0 crates/pep440-rs/Cargo.toml | 12 +- crates/pep440-rs/{Readme.md => README.md} | 0 crates/pep508-rs/Cargo.toml | 10 +- crates/platform-host/Cargo.toml | 14 +- crates/platform-tags/Cargo.toml | 14 +- crates/puffin-installer/Cargo.toml | 14 +- crates/puffin-interpreter/Cargo.toml | 14 +- crates/puffin-resolver/Cargo.toml | 14 +- crates/wheel-filename/Cargo.toml | 16 +- 15 files changed, 283 insertions(+), 57 deletions(-) create mode 100644 .github/workflows/release.yml rename crates/gourgeist/{Readme.md => README.md} (100%) rename crates/pep440-rs/{Changelog.md => CHANGELOG.md} (100%) rename crates/pep440-rs/{Readme.md => README.md} (100%) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000000..7997a9c1b7c8 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,191 @@ +# Copyright 2022-2023, 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 release 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 release 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 Github Release™ 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 Github Release™ +# will be marked as a prerelease. +on: + push: + tags: + - '**[0-9]+.[0-9]+.[0-9]+*' + pull_request: + +jobs: + # Run 'cargo dist plan' to determine what tasks we need to do + plan: + runs-on: ubuntu-latest + 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 + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.1/cargo-dist-installer.sh | sh" + - id: plan + run: | + cargo dist plan ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} --output-format=json > dist-manifest.json + echo "cargo dist plan ran successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: dist-manifest.json + + # Build and packages all the platform-specific things + upload-local-artifacts: + # Let the initial task tell us to not run (currently very blunt) + needs: plan + if: ${{ fromJson(needs.plan.outputs.val).releases != 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 }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: swatinem/rust-cache@v2 + - name: Install cargo-dist + run: ${{ matrix.install_dist }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + cargo dist build ${{ needs.plan.outputs.tag-flag }} --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 the Github Release™ + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + - name: "Upload artifacts" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: ${{ steps.cargo-dist.outputs.paths }} + + # Build and package all the platform-agnostic(ish) things + upload-global-artifacts: + needs: [plan, upload-local-artifacts] + runs-on: "ubuntu-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cargo-dist + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.1/cargo-dist-installer.sh | sh" + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v3 + with: + name: artifacts + path: target/distrib/ + - 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 the Github Release™ + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + - name: "Upload artifacts" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: ${{ steps.cargo-dist.outputs.paths }} + + should-publish: + needs: + - plan + - upload-local-artifacts + - upload-global-artifacts + if: ${{ needs.plan.outputs.publishing == 'true' }} + runs-on: ubuntu-latest + steps: + - name: print tag + run: echo "ok we're publishing!" + + # Create a Github Release with all the results once everything is done, + publish-release: + needs: [plan, should-publish] + runs-on: ubuntu-latest + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: "Download artifacts" + uses: actions/download-artifact@v3 + with: + name: artifacts + path: artifacts + - name: Create Release + uses: ncipollo/release-action@v1 + with: + tag: ${{ needs.plan.outputs.tag }} + name: ${{ fromJson(needs.plan.outputs.val).announcement_title }} + body: ${{ fromJson(needs.plan.outputs.val).announcement_github_body }} + prerelease: ${{ fromJson(needs.plan.outputs.val).announcement_is_prerelease }} + artifacts: "artifacts/*" diff --git a/Cargo.toml b/Cargo.toml index cb565e1d94b5..3be87ce26e17 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -58,3 +58,21 @@ url = { version = "2.4.1" } walkdir = { version = "2.4.0" } which = { version = "4.4.2" } zip = { version = "0.6.6", default-features = false, features = ["deflate"] } + +# Config for 'cargo dist' +[workspace.metadata.dist] +# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.3.1" +# CI backends to support +ci = ["github"] +# The installers to generate for each app +installers = ["shell"] +# Target platforms to build apps for (Rust target-triple syntax) +targets = ["x86_64-unknown-linux-gnu", "aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-pc-windows-msvc"] +# Publish jobs to run in CI +pr-run-mode = "plan" + +# The profile that 'cargo dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/crates/gourgeist/Cargo.toml b/crates/gourgeist/Cargo.toml index 4578629526f6..e951804a9fbd 100644 --- a/crates/gourgeist/Cargo.toml +++ b/crates/gourgeist/Cargo.toml @@ -1,12 +1,16 @@ [package] name = "gourgeist" version = "0.0.4" -edition = "2021" description = "virtualenv creation implemented in rust" -repository = "https://github.com/konstin/gourgeist" -license = "MIT OR Apache-2.0" keywords = ["virtualenv", "venv", "python"] -readme = "Readme.md" + +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] install-wheel-rs = { path = "../install-wheel-rs", optional = true } diff --git a/crates/gourgeist/Readme.md b/crates/gourgeist/README.md similarity index 100% rename from crates/gourgeist/Readme.md rename to crates/gourgeist/README.md diff --git a/crates/install-wheel-rs/Cargo.toml b/crates/install-wheel-rs/Cargo.toml index f1115c08b7ce..69a4176bd77f 100644 --- a/crates/install-wheel-rs/Cargo.toml +++ b/crates/install-wheel-rs/Cargo.toml @@ -1,12 +1,17 @@ [package] name = "install-wheel-rs" version = "0.0.1" -edition = "2021" description = "Takes a wheel and installs it, either in a venv or for monotrail" -license = "MIT OR Apache-2.0" -repository = "https://github.com/konstin/poc-monotrail" keywords = ["wheel", "python"] +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } + [lib] name = "install_wheel_rs" diff --git a/crates/pep440-rs/Changelog.md b/crates/pep440-rs/CHANGELOG.md similarity index 100% rename from crates/pep440-rs/Changelog.md rename to crates/pep440-rs/CHANGELOG.md diff --git a/crates/pep440-rs/Cargo.toml b/crates/pep440-rs/Cargo.toml index 6ad668f0b926..5b8cd62f0509 100644 --- a/crates/pep440-rs/Cargo.toml +++ b/crates/pep440-rs/Cargo.toml @@ -2,11 +2,15 @@ name = "pep440_rs" version = "0.3.12" description = "A library for python version numbers and specifiers, implementing PEP 440" -edition = "2021" -include = ["/src", "Changelog.md", "License-Apache", "License-BSD", "Readme.md", "pyproject.toml"] license = "Apache-2.0 OR BSD-2-Clause" -repository = "https://github.com/konstin/pep440-rs" -readme = "Readme.md" +include = ["/src", "Changelog.md", "License-Apache", "License-BSD", "Readme.md", "pyproject.toml"] + +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } [lib] name = "pep440_rs" diff --git a/crates/pep440-rs/Readme.md b/crates/pep440-rs/README.md similarity index 100% rename from crates/pep440-rs/Readme.md rename to crates/pep440-rs/README.md diff --git a/crates/pep508-rs/Cargo.toml b/crates/pep508-rs/Cargo.toml index b636fcc5fd3f..a7cf5f53f57a 100644 --- a/crates/pep508-rs/Cargo.toml +++ b/crates/pep508-rs/Cargo.toml @@ -2,11 +2,15 @@ name = "pep508_rs" version = "0.2.3" description = "A library for python dependency specifiers, better known as PEP 508" -edition = "2021" include = ["/src", "Changelog.md", "License-Apache", "License-BSD", "Readme.md", "pyproject.toml"] license = "Apache-2.0 OR BSD-2-Clause" -readme = "Readme.md" -repository = "https://github.com/konstin/pep508_rs" + +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } [lib] name = "pep508_rs" diff --git a/crates/platform-host/Cargo.toml b/crates/platform-host/Cargo.toml index d30020634a20..e1e0defdb5be 100644 --- a/crates/platform-host/Cargo.toml +++ b/crates/platform-host/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "platform-host" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] pep440_rs = { path = "../pep440-rs" } diff --git a/crates/platform-tags/Cargo.toml b/crates/platform-tags/Cargo.toml index de859c8f4e43..8e3740885847 100644 --- a/crates/platform-tags/Cargo.toml +++ b/crates/platform-tags/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "platform-tags" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] platform-host = { path = "../platform-host" } diff --git a/crates/puffin-installer/Cargo.toml b/crates/puffin-installer/Cargo.toml index 2ec0019f4a64..92486132a3af 100644 --- a/crates/puffin-installer/Cargo.toml +++ b/crates/puffin-installer/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "puffin-installer" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] install-wheel-rs = { path = "../install-wheel-rs", default-features = false } diff --git a/crates/puffin-interpreter/Cargo.toml b/crates/puffin-interpreter/Cargo.toml index 6acfab4a931b..4387d5886437 100644 --- a/crates/puffin-interpreter/Cargo.toml +++ b/crates/puffin-interpreter/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "puffin-interpreter" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] pep440_rs = { path = "../pep440-rs" } diff --git a/crates/puffin-resolver/Cargo.toml b/crates/puffin-resolver/Cargo.toml index a319ff77b367..dceea7dd9c13 100644 --- a/crates/puffin-resolver/Cargo.toml +++ b/crates/puffin-resolver/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "puffin-resolver" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] platform-tags = { path = "../platform-tags" } diff --git a/crates/wheel-filename/Cargo.toml b/crates/wheel-filename/Cargo.toml index d0a99b10ff2c..9d29d79c307b 100644 --- a/crates/wheel-filename/Cargo.toml +++ b/crates/wheel-filename/Cargo.toml @@ -1,15 +1,15 @@ [package] name = "wheel-filename" version = "0.1.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +authors = { workspace = true } +license = { workspace = true } [dependencies] platform-tags = { path = "../platform-tags" } -thiserror = { workspace = true } \ No newline at end of file +thiserror = { workspace = true }