From f825bc652d73c06f35087987bc1eac8b8700c3cb Mon Sep 17 00:00:00 2001 From: Marcin Nowak-Liebiediew Date: Mon, 27 Nov 2023 16:18:41 +0100 Subject: [PATCH] fix: release process (#66) --- .github/workflows/e2e.yml | 5 +- .github/workflows/release-with-github.yml | 10 +- .github/workflows/release.yml | 214 ++++++++++++---------- Cargo.toml | 1 + 4 files changed, 127 insertions(+), 103 deletions(-) diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 36d9fa4..31d27eb 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -27,10 +27,11 @@ jobs: if: contains(matrix.os, 'macos-12') == false - name: Install sponge and timeout run: brew install coreutils sponge + - uses: cargo-bins/cargo-binstall@main - name: Install cargo-dist - run: cargo install cargo-dist + run: cargo binstall cargo-dist -y - name: Install IC SDK (dfx) - run: DFX_VERSION="0.15.0-ext.0" sh -ci "$(curl -sSL https://internetcomputer.org/install.sh)" + uses: dfinity/setup-dfx@main - name: run test run: timeout 2400 e2e/bats/bin/bats ${{ matrix.test_file_path }} diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/release-with-github.yml index 032a6eb..94a1777 100644 --- a/.github/workflows/release-with-github.yml +++ b/.github/workflows/release-with-github.yml @@ -40,7 +40,7 @@ jobs: outputs: nev_version: ${{ steps.determine_version.outputs.NEW_VERSION }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - uses: cargo-bins/cargo-binstall@main @@ -92,7 +92,7 @@ jobs: needs: [create-release, call-release-binaries-workflow] runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Open the release PR env: GH_TOKEN: ${{ github.token }} @@ -100,6 +100,8 @@ jobs: TAG="${{ inputs.whichCrate }}-v${{ needs.create-release.outputs.nev_version }}" HEAD="release/$TAG" TITLE="chore(${{ inputs.whichCrate }}): release v${{ needs.create-release.outputs.nev_version }}" - echo "PR created by this workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" >> BODY.md - echo "Link to release: https://github.com/dfinity/dfx-extensions/releases/tag/$TAG" >> BODY.md + cat >BODY.md <> "$GITHUB_ENV" echo "TAG=$TAG" >> "$GITHUB_OUTPUT" - - uses: actions/checkout@v3 + # Run 'cargo dist plan' to determine what tasks we need to do + plan: + runs-on: ubuntu-latest + needs: determine-release-tag + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ !github.event.pull_request && needs.determine-release-tag.outputs.release-tag || '' }} + tag-flag: ${{ !github.event.pull_request && format('--tag={0}', needs.determine-release-tag.outputs.release-tag) || '' }} + publishing: ${{ !github.event.pull_request }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 with: - ref: ${{ env.TAG }} + ref: ${{ needs.determine-release-tag.outputs.release-tag }} 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: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.4.3/cargo-dist-installer.sh | sh" + - id: plan run: | - cargo dist plan --tag=${{ env.TAG }} --output-format=json > dist-manifest.json - echo "dist plan ran successfully" + cargo dist plan ${{ !github.event.pull_request && format('--tag={0}', needs.determine-release-tag.outputs.release-tag) || '' }} --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 - # 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 ${{ env.TAG }} --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 ${{ env.TAG }} 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: + # Build and packages all the platform-specific things + upload-local-artifacts: # Let the initial task tell us to not run (currently very blunt) - needs: create-release - if: ${{ needs.create-release.outputs.has-releases == 'true' }} + 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 - matrix: - # For these target platforms - include: - - os: "macos-latest" - 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-latest" - 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: "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 }} + # 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: Get correct tag - run: echo "TAG=${{ needs.create-release.outputs.release-tag }}" >> "$GITHUB_ENV" - - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: - ref: ${{ env.TAG }} + ref: ${{ needs.plan.outputs.tag }} submodules: recursive - + - uses: swatinem/rust-cache@v2 - 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: ${{ matrix.install_dist }} + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + - name: Build artifacts run: | # Actually do builds and make zips and whatnot - cargo dist build --tag=${{ env.TAG }} --output-format=json ${{ matrix.dist-args }} > dist-manifest.json - echo "dist ran successfully" - cat dist-manifest.json - + 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™ - jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json > uploads.txt - echo "uploading..." - cat uploads.txt - gh release upload ${{ env.TAG }} $(cat uploads.txt) - echo "uploaded!" + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" - # Mark the Github Release™ as a non-draft now that everything has succeeded! + 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 }} + + should-publish: + needs: + - plan + - upload-local-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: - # 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') }} + needs: [plan, should-publish] runs-on: ubuntu-latest env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: submodules: recursive - - name: Get correct tag - run: echo "TAG=${{ needs.create-release.outputs.release-tag }}" >> "$GITHUB_ENV" - - name: mark release as non-draft + - name: "Download artifacts" + uses: actions/download-artifact@v3 + with: + name: artifacts + path: artifacts + - name: Cleanup run: | - gh release edit ${{ env.TAG }} --draft=false + # Remove the granular manifests + rm artifacts/*-dist-manifest.json + - 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 d31f64c..39114b4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -45,6 +45,7 @@ targets = [ unix-archive = ".tar.gz" checksum = "sha256" dist = true +allow-dirty = ["ci"] # The profile that 'cargo dist' will build with