From 1baef7d845eb51e75d8d4d39ac9426b04fd22716 Mon Sep 17 00:00:00 2001 From: Georg Semmler Date: Wed, 18 Oct 2023 09:09:57 +0200 Subject: [PATCH 1/2] Try to setup a cargo-dist workflow --- .github/workflows/ci.yml | 1 + .github/workflows/release.yml | 218 +++++++++++++++++++++++++ .typos.toml | 1 + Cargo.toml | 25 +++ diesel_cli/Cargo.toml | 19 +++ diesel_derives/Cargo.toml | 3 +- diesel_table_macro_syntax/Cargo.toml | 2 +- examples/postgres/relations/Cargo.toml | 1 + 8 files changed, 268 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 964c5757270f..c0e2281e08b9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -194,6 +194,7 @@ jobs: echo "MYSQLCLIENT_LIB_DIR=C:\tools\mysql\current\lib" >> $GITHUB_ENV echo "C:\tools\mysql\current\lib" >> $GITHUB_PATH echo "C:\tools\mysql\current\bin" >> $GITHUB_PATH + dir "C:\tools\mysql\current\lib" - name: Install rust toolchain uses: dtolnay/rust-toolchain@master diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000000..a0395be45b47 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,218 @@ +# 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 a Github Release™ with this tag is assumed to exist as a draft +# with the appropriate title/body, and will be undrafted for you. +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.4.0/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 }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: swatinem/rust-cache@v2 + - name: Install cargo-dist + run: ${{ matrix.install_dist }} + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + # In the step above cargo dist installs the x86_64 version of the dependencies + # We need the aarch64 versions for the aarch64 build so we manually + # install them + - name: Install dependencies (aarch64-apple-darwin) + if: runner.os == 'macOS' && contains(matrix.dist_args, 'aarch64-apple-darwin') + run: | + response=$(brew fetch --force --bottle-tag=arm64_big_sur libpq | grep "Downloaded to") + parsed=$(echo $response | sed -e 's/Downloaded to: //g') + brew reinstall $parsed + response=$(brew fetch --force --bottle-tag=arm64_big_sur mysql-client | grep "Downloaded to") + parsed=$(echo $response | sed -e 's/Downloaded to: //g') + brew reinstall $parsed + echo "${{ matrix.dist_args }}" + - 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 the Github Release™ + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + # 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.4.0/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: Cleanup + run: | + # Remove the granular manifests + rm artifacts/*-dist-manifest.json + - name: Create Release + uses: ncipollo/release-action@v1 + with: + tag: ${{ needs.plan.outputs.tag }} + allowUpdates: true + updateOnlyUnreleased: true + omitBodyDuringUpdate: true + omitNameDuringUpdate: true + prerelease: ${{ fromJson(needs.plan.outputs.val).announcement_is_prerelease }} + artifacts: "artifacts/*" diff --git a/.typos.toml b/.typos.toml index 86f277e23e7f..80503a2a6eca 100644 --- a/.typos.toml +++ b/.typos.toml @@ -20,6 +20,7 @@ extend-ignore-re = [ "cannot find value `titel` in module `posts`", "cannot find type `titel` in module `posts`", "[0-9]+[[:space]]+|[[:space:]]+titel: String", + "big_sur" ] [type.md] diff --git a/Cargo.toml b/Cargo.toml index 875009fd7818..047c44200721 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,8 +29,33 @@ members = [ "examples/sqlite/getting_started_step_3", ] +# Config for 'cargo dist' +[workspace.metadata.dist] +# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.4.0" +# CI backends to support +ci = ["github"] +# The installers to generate for each app +installers = ["shell", "powershell"] +# 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"] +# Publish jobs to run in CI +pr-run-mode = "upload" +# Skip checking whether the specified configuration files are up to date +allow-dirty = ["ci"] +# Whether cargo-dist should create a Github Release or use an existing draft +create-release = false +# We link several dynamic libraries (libpq, libmysqlclient), so this is kind of +# required for now +msvc-crt-static = false + [profile.dev.package.insta] opt-level = 3 [profile.dev.package.similar] opt-level = 3 + +# The profile that 'cargo dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/diesel_cli/Cargo.toml b/diesel_cli/Cargo.toml index b1e4ee8d960d..1a2eeb75ff67 100644 --- a/diesel_cli/Cargo.toml +++ b/diesel_cli/Cargo.toml @@ -13,6 +13,10 @@ edition = "2021" include = ["src/**/*", "LICENSE-*", "README.md"] rust-version = "1.66.0" +[package.metadata.wix] +upgrade-guid = "AC330981-F4F8-4D8A-AD78-F8B7ECC32DF3" +path-guid = "1730337B-A19D-4DDE-AFA5-983752956861" + [[bin]] name = "diesel" path = "src/main.rs" @@ -58,3 +62,18 @@ uses_information_schema = [] [[test]] name = "tests" + +[package.metadata.dist] +features = ["sqlite-bundled"] + +[package.metadata.dist.dependencies.apt] +libpq-dev = '*' +libmysqlclient-dev = '*' + +[package.metadata.dist.dependencies.homebrew] +libpq = '*' +mysql-client = '*' + +[package.metadata.dist.dependencies.chocolatey] +postgresql12 = '*' +mysql = '*' diff --git a/diesel_derives/Cargo.toml b/diesel_derives/Cargo.toml index ebe6567d2958..57e1136ee859 100644 --- a/diesel_derives/Cargo.toml +++ b/diesel_derives/Cargo.toml @@ -5,7 +5,7 @@ license = "MIT OR Apache-2.0" description = "You should not use this crate directly, it is internal to Diesel." documentation = "https://diesel.rs/guides/" homepage = "https://diesel.rs" -repository = "https://github.com/diesel-rs/diesel/tree/master/diesel_derives" +repository = "https://github.com/diesel-rs/diesel/" autotests = false include = ["src/**/*", "LICENSE-*"] rust-version = "1.66.0" @@ -46,3 +46,4 @@ with-deprecated = [] r2d2 = [] chrono = [] time = [] + diff --git a/diesel_table_macro_syntax/Cargo.toml b/diesel_table_macro_syntax/Cargo.toml index 41032f81093a..e4c20024a411 100644 --- a/diesel_table_macro_syntax/Cargo.toml +++ b/diesel_table_macro_syntax/Cargo.toml @@ -5,7 +5,7 @@ description = "Internal diesel crate" license = "MIT OR Apache-2.0" documentation = "https://diesel.rs/guides/" homepage = "https://diesel.rs" -repository = "https://github.com/diesel-rs/diesel/tree/master/diesel_table_macro_syntax" +repository = "https://github.com/diesel-rs/diesel/" autotests = false include = ["src/**/*", "LICENSE-*"] rust-version = "1.66.0" diff --git a/examples/postgres/relations/Cargo.toml b/examples/postgres/relations/Cargo.toml index e45407d5b046..d01a91aea0e6 100644 --- a/examples/postgres/relations/Cargo.toml +++ b/examples/postgres/relations/Cargo.toml @@ -2,6 +2,7 @@ name = "relations" version = "0.1.0" edition = "2021" +publish = false # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html From a2a646d73777bf4d11cceb926391dd9e5265a12e Mon Sep 17 00:00:00 2001 From: Georg Semmler Date: Tue, 31 Oct 2023 09:49:28 +0100 Subject: [PATCH 2/2] It's fine to only plan in CI --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 047c44200721..ff383355fdb7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -40,7 +40,7 @@ installers = ["shell", "powershell"] # 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"] # Publish jobs to run in CI -pr-run-mode = "upload" +pr-run-mode = "plan" # Skip checking whether the specified configuration files are up to date allow-dirty = ["ci"] # Whether cargo-dist should create a Github Release or use an existing draft