From 1d52eeb69af24ea1880ed343c167fe1dca415c30 Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 09:07:30 -0800 Subject: [PATCH 1/7] chore: use standard cargo-dist 0.10.0 release script --- .github/workflows/release.yml | 210 ++++++++++++++++++++++------------ Cargo.toml | 4 +- 2 files changed, 140 insertions(+), 74 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b47f0a1..7d2b810 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -6,10 +6,11 @@ # * 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™ +# * on success, uploads the artifacts to a Github Release # -# Note that the Github Release™ will be created with a generated +# Note that the Github Release will be created with a generated # title/body based on your changelogs. + name: Release permissions: @@ -21,89 +22,71 @@ permissions: # 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 +# 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 release will be for all +# 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 Github Release™ for each one. However Github +# 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 Github Release™ +# If there's a prerelease-style suffix to the version, then the release(s) # will be marked as a prerelease. on: - workflow_call: - inputs: - release_tag: - required: true - type: string push: tags: - '**[0-9]+.[0-9]+.[0-9]+*' + pull_request: jobs: - determine-release-tag: - runs-on: ubuntu-latest - outputs: - release-tag: ${{ steps.determine-release-tag.outputs.TAG }} - steps: - - name: Determine correct tag - id: determine-release-tag - run: | - echo 'INFO: Release tag received from input: ${{ inputs.release_tag }}' - echo 'INFO: GitHub context ref_name: ${{ github.ref_name }}' - if [[ "${{ github.workflow }}" == "Release with GitHub Action" ]] - then - echo "INFO: This run has been triggered from other workflow" - TAG=${{ inputs.release_tag }} - else - echo "INFO: This run has been triggered from pushing the tag" - TAG=${{ github.ref_name }} - fi - echo "INFO: The release tag is: $TAG" - echo "TAG=$TAG" >> "$GITHUB_ENV" - echo "TAG=$TAG" >> "$GITHUB_OUTPUT" - - # Run 'cargo dist plan' to determine what tasks we need to do + # Run 'cargo dist plan' (or host) 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) || '' }} + 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: - 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.9.0/cargo-dist-installer.sh | sh" + # 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.10.0/cargo-dist-installer.sh | sh" + # 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 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" + 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@v3 + uses: actions/upload-artifact@v4 with: - name: artifacts - path: dist-manifest.json + name: artifacts-plan-dist-manifest + path: plan-dist-manifest.json # Build and packages all the platform-specific things - upload-local-artifacts: + 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).releases != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} + 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. @@ -124,11 +107,17 @@ jobs: steps: - uses: actions/checkout@v4 with: - ref: ${{ needs.plan.outputs.tag }} submodules: recursive - uses: swatinem/rust-cache@v2 - 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 }} @@ -144,54 +133,133 @@ jobs: # inconsistent syntax between shell and powershell. shell: bash run: | - # Parse out what we just built and upload it to the Github Release™ + # Parse out what we just built and upload it to scratch storage 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 + uses: actions/upload-artifact@v4 with: - name: artifacts + name: artifacts-build-local-${{ join(matrix.targets, '_') }} path: | ${{ steps.cargo-dist.outputs.paths }} ${{ env.BUILD_MANIFEST_NAME }} - should-publish: + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: needs: - plan - - upload-local-artifacts - if: ${{ needs.plan.outputs.publishing == 'true' }} - runs-on: ubuntu-latest + - build-local-artifacts + runs-on: "ubuntu-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json steps: - - name: print tag - run: echo "ok we're publishing!" + - 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.10.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@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" - # Create a Github Release with all the results once everything is done - publish-release: - needs: [plan, should-publish] - runs-on: ubuntu-latest + # Parse out what we just built and upload it to scratch storage + 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@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 cargo-dist + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.10.0/cargo-dist-installer.sh | sh" + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + # This is a harmless no-op for Github Releases, hosting for that happens in "announce" + - 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 + 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 - - name: "Download artifacts" - uses: actions/download-artifact@v3 + - name: "Download Github Artifacts" + uses: actions/download-artifact@v4 with: - name: artifacts + pattern: artifacts-* path: artifacts + merge-multiple: true - name: Cleanup run: | # Remove the granular manifests - rm artifacts/*-dist-manifest.json - - name: Create Release + rm -f artifacts/*-dist-manifest.json + - name: Create Github 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 }} + name: ${{ fromJson(needs.host.outputs.val).announcement_title }} + body: ${{ fromJson(needs.host.outputs.val).announcement_github_body }} + prerelease: ${{ fromJson(needs.host.outputs.val).announcement_is_prerelease }} artifacts: "artifacts/*" diff --git a/Cargo.toml b/Cargo.toml index 4632a0d..a72cd25 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -44,10 +44,8 @@ unix-archive = ".tar.gz" checksum = "sha256" # Whether to consider the binaries in a package for distribution (defaults true) dist = true -# Skip checking whether the specified configuration files are up to date -allow-dirty = ["ci"] # The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) -cargo-dist-version = "0.9.0" +cargo-dist-version = "0.10.0" # The installers to generate for each app installers = [] # Publish jobs to run in CI From e8ec9f859245fb51ed9e57ada4b34f4ff8410bbd Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 09:44:13 -0800 Subject: [PATCH 2/7] update release workflow to work with standard cargo-dist release workflow --- .github/workflows/release-with-github.yml | 83 ++++++++++++----------- extensions/nns/Cargo.toml | 8 --- extensions/nns/prepare-release.toml | 11 +++ extensions/sns/Cargo.toml | 8 --- extensions/sns/prepare-release.toml | 11 +++ 5 files changed, 66 insertions(+), 55 deletions(-) create mode 100644 extensions/nns/prepare-release.toml create mode 100644 extensions/sns/prepare-release.toml diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/release-with-github.yml index 94a1777..6163305 100644 --- a/.github/workflows/release-with-github.yml +++ b/.github/workflows/release-with-github.yml @@ -36,36 +36,44 @@ on: jobs: create-release: runs-on: ubuntu-latest - if: ${{ !(inputs.semverBump == 'custom' && inputs.semverVersion == '') }} - outputs: - nev_version: ${{ steps.determine_version.outputs.NEW_VERSION }} steps: + - name: check parameters + if: ${{ inputs.semverBump == 'custom' && inputs.semverVersion == '' }} + run: | + echo "You have selected [custom] in the previous dropdown, but you have not provided the exact version. Please provide the exact version." + exit 1 + - uses: actions/checkout@v4 with: fetch-depth: 0 - uses: cargo-bins/cargo-binstall@main - run: cargo binstall cargo-release -y + + - name: Unify semver choice + env: + SEMVER_CHOICE: ${{ inputs.semverBump == 'custom' && inputs.semverVersion || inputs.semverBump }} + run: | + echo "SEMVER_CHOICE is $SEMVER_CHOICE" + echo "SEMVER_CHOICE=$SEMVER_CHOICE" >> "$GITHUB_ENV" + - name: Determine new version number by dry-running `cargo-release` - id: determine_version - continue-on-error: true run: | - if [[ "${{ inputs.semverBump }}" == "custom" ]] - then - cargo release version -p ${{ inputs.whichCrate }} ${{ inputs.semverVersion }} &> cargo-release-output.txt - else - cargo release version -p ${{ inputs.whichCrate }} ${{ inputs.semverBump }} &> cargo-release-output.txt - fi - cat cargo-release-output.txt - NEW_VERSION=$(grep -oP 'Upgrading .* from .* to \K[^\s]*' cargo-release-output.txt | tr -d ' ') - echo "$NEW_VERSION" + echo "SEMVER_CHOICE is $SEMVER_CHOICE" + NEW_VERSION="$( + cargo release version -p ${{ inputs.whichCrate}} ${{ env.SEMVER_CHOICE }} 2>&1 \ + | grep "Upgrading .* from .* to .*" \ + | awk '{print $6}' \ + )" + + echo "New version is $NEW_VERSION" echo "NEW_VERSION=$NEW_VERSION" >> "$GITHUB_ENV" - echo "NEW_VERSION=$NEW_VERSION" >> "$GITHUB_OUTPUT" - rm cargo-release-output.txt - - name: Switch to the release branch, and push it + + - name: Switch to the release branch run: | BRANCH_NAME="release/${{ inputs.whichCrate }}-v${{ env.NEW_VERSION }}" - git checkout -b "$BRANCH_NAME" - git push --set-upstream origin "$BRANCH_NAME" + git switch -c "$BRANCH_NAME" + + - name: Set up git config run: | git config author.email "${{ github.event.sender.id }}+${{ github.event.sender.login }}@users.noreply.github.com" @@ -74,34 +82,31 @@ jobs: git config committer.name "GitHub Actions Bot" git config user.email "${{ github.event.sender.id }}+${{ github.event.sender.login }}@users.noreply.github.com" git config user.name "${{ github.event.sender.login }}" - - name: Execute `cargo-release` - if: ${{ inputs.semverBump != 'custom' }} - run: cargo release -p ${{ inputs.whichCrate }} --execute --no-confirm ${{ inputs.semverBump }} - - name: Execute `cargo-release` - if: ${{ inputs.semverBump == 'custom' }} - run: cargo release -p ${{ inputs.whichCrate }} --execute --no-confirm ${{ inputs.semverVersion }} + - name: Roll changelog, bump version, and push branch + run: | + # see https://opensource.axo.dev/cargo-dist/book/workspaces/cargo-release-guide.html#using-cargo-release-with-pull-requests + cargo release -p ${{ inputs.whichCrate }} "${{ env.SEMVER_CHOICE }}" --execute --no-confirm --config extensions/${{ inputs.whichCrate }}/prepare-release.toml - call-release-binaries-workflow: - needs: create-release - uses: ./.github/workflows/release.yml - with: - release_tag: ${{ inputs.whichCrate }}-v${{ needs.create-release.outputs.nev_version }} - - create-release-pr: - needs: [create-release, call-release-binaries-workflow] - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - name: Open the release PR env: GH_TOKEN: ${{ github.token }} run: | - TAG="${{ inputs.whichCrate }}-v${{ needs.create-release.outputs.nev_version }}" + TAG="${{ inputs.whichCrate }}-v${{ env.NEW_VERSION }}" HEAD="release/$TAG" - TITLE="chore(${{ inputs.whichCrate }}): release v${{ needs.create-release.outputs.nev_version }}" + TITLE="chore(${{ inputs.whichCrate }}): release v${{ env.NEW_VERSION }}" cat >BODY.md < Date: Fri, 16 Feb 2024 09:50:47 -0800 Subject: [PATCH 3/7] enable PR creation --- .github/workflows/release-with-github.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/release-with-github.yml index 6163305..9e44a61 100644 --- a/.github/workflows/release-with-github.yml +++ b/.github/workflows/release-with-github.yml @@ -109,4 +109,4 @@ jobs: EOF echo "Body:" cat BODY.md - echo gh pr create --base main --head "$HEAD" --title "$TITLE" --body-file BODY.md + gh pr create --base main --head "$HEAD" --title "$TITLE" --body-file BODY.md From a9111f16d47d57f513b784d77580eaea71e1bffb Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 09:53:55 -0800 Subject: [PATCH 4/7] show git status --- .github/workflows/release-with-github.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/release-with-github.yml index 9e44a61..0fc54a3 100644 --- a/.github/workflows/release-with-github.yml +++ b/.github/workflows/release-with-github.yml @@ -109,4 +109,6 @@ jobs: EOF echo "Body:" cat BODY.md + echo "git status:" + git status gh pr create --base main --head "$HEAD" --title "$TITLE" --body-file BODY.md From f9b0964cc502d0bf0c2c269fc0bf636871f4b682 Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 09:59:35 -0800 Subject: [PATCH 5/7] . --- .github/workflows/release-with-github.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/release-with-github.yml index 0fc54a3..76e14c8 100644 --- a/.github/workflows/release-with-github.yml +++ b/.github/workflows/release-with-github.yml @@ -107,8 +107,5 @@ jobs: cargo release -p ${{ inputs.whichCrate }} --execute \`\`\` EOF - echo "Body:" - cat BODY.md - echo "git status:" - git status + echo 'The message "Warning: 1 uncommitted change" refers to BODY.md' gh pr create --base main --head "$HEAD" --title "$TITLE" --body-file BODY.md From 05598bf483de9ebbd1b61fd8fcb9be3da2b41fb3 Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 10:03:38 -0800 Subject: [PATCH 6/7] rename --- .../workflows/{release-with-github.yml => prepare-release.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{release-with-github.yml => prepare-release.yml} (100%) diff --git a/.github/workflows/release-with-github.yml b/.github/workflows/prepare-release.yml similarity index 100% rename from .github/workflows/release-with-github.yml rename to .github/workflows/prepare-release.yml From 7fae889ad57802611dfbbfee6def4e2608891146 Mon Sep 17 00:00:00 2001 From: Eric Swanson Date: Fri, 16 Feb 2024 10:25:55 -0800 Subject: [PATCH 7/7] update cargo-dist version in e2e --- .github/workflows/e2e.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index d54ea98..d2b4a3d 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -29,7 +29,7 @@ jobs: run: brew install coreutils sponge - uses: cargo-bins/cargo-binstall@main - name: Install cargo-dist - run: cargo binstall cargo-dist@0.9.0 -y + run: cargo binstall cargo-dist@0.10.0 -y - name: Install IC SDK (dfx) uses: dfinity/setup-dfx@main - name: run test