-
-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use cargo-dist to create release artifacts
This will create binaries for more platforms (including ARM builds for MacOS) and installer scripts in addition to just the binaries themselves.
- Loading branch information
Showing
11 changed files
with
225 additions
and
125 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,140 +1,211 @@ | ||
| name: Create release | ||
| # 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: | ||
| - "v*" | ||
|
|
||
| env: | ||
| SCCACHE_GHA_ENABLED: "true" | ||
| RUSTC_WRAPPER: "sccache" | ||
| - '**[0-9]+.[0-9]+.[0-9]+*' | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| create-release: | ||
| name: Create release | ||
| # Run 'cargo dist plan' to determine what tasks we need to do | ||
| plan: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| upload_url: "${{ steps.create_release.outputs.upload_url }}" | ||
| 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: | ||
| - id: create_release | ||
| uses: actions/create-release@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| - 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.3/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: | ||
| tag_name: ${{ github.ref }} | ||
| release_name: ${{ github.ref }} | ||
| draft: true | ||
| prerelease: false | ||
| name: artifacts | ||
| path: dist-manifest.json | ||
|
|
||
| build-linux: | ||
| name: Linux binary | ||
| needs: create-release | ||
| runs-on: ubuntu-latest | ||
| # 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 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| id: setup_rust | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/.cargo/bin/ | ||
| ~/.cargo/registry/index/ | ||
| ~/.cargo/registry/cache/ | ||
| ~/.cargo/git/db/ | ||
| target/ | ||
| key: "cargo-build-linux-${{ steps.setup_rust.outputs.cachekey }}" | ||
| - name: Run sccache-cache | ||
| uses: mozilla-actions/[email protected] | ||
|
|
||
| - run: cargo build --release --locked | ||
| - run: strip target/release/obsidian-export | ||
|
|
||
| - uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: Linux binary | ||
| path: target/release/obsidian-export | ||
| retention-days: 7 | ||
| submodules: recursive | ||
| - uses: swatinem/rust-cache@v2 | ||
| - name: Install cargo-dist | ||
| 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 ${{ 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<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
| - uses: actions/upload-release-asset@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| cp dist-manifest.json "$BUILD_MANIFEST_NAME" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| upload_url: ${{ needs.create-release.outputs.upload_url }} | ||
| asset_path: target/release/obsidian-export | ||
| asset_name: obsidian-export_Linux-x86_64.bin | ||
| asset_content_type: application/octet-stream | ||
| name: artifacts | ||
| path: | | ||
| ${{ steps.cargo-dist.outputs.paths }} | ||
| ${{ env.BUILD_MANIFEST_NAME }} | ||
| build-windows: | ||
| name: Windows binary | ||
| needs: create-release | ||
| runs-on: windows-latest | ||
| # 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 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| id: setup_rust | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/.cargo/bin/ | ||
| ~/.cargo/registry/index/ | ||
| ~/.cargo/registry/cache/ | ||
| ~/.cargo/git/db/ | ||
| target/ | ||
| key: "cargo-build-linux-${{ steps.setup_rust.outputs.cachekey }}" | ||
| - name: Run sccache-cache | ||
| uses: mozilla-actions/[email protected] | ||
|
|
||
| - run: cargo build --release --locked | ||
| - run: strip target/release/obsidian-export.exe | ||
|
|
||
| - uses: actions/upload-artifact@v3 | ||
| submodules: recursive | ||
| - name: Install cargo-dist | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.4.3/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: Windows binary | ||
| path: target/release/obsidian-export.exe | ||
| retention-days: 7 | ||
| 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" | ||
| - uses: actions/upload-release-asset@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| # Parse out what we just built and upload it to the Github Release™ | ||
| echo "paths<<EOF" >> "$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: | ||
| upload_url: ${{ needs.create-release.outputs.upload_url }} | ||
| asset_path: target/release/obsidian-export.exe | ||
| asset_name: obsidian-export_Windows-x64_64.exe | ||
| asset_content_type: application/octet-stream | ||
| name: artifacts | ||
| path: ${{ steps.cargo-dist.outputs.paths }} | ||
|
|
||
| build-macos: | ||
| name: Mac OS binary | ||
| needs: create-release | ||
| runs-on: macos-latest | ||
| should-publish: | ||
| needs: | ||
| - plan | ||
| - upload-local-artifacts | ||
| - upload-global-artifacts | ||
| if: ${{ needs.plan.outputs.publishing == 'true' }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| id: setup_rust | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/.cargo/bin/ | ||
| ~/.cargo/registry/index/ | ||
| ~/.cargo/registry/cache/ | ||
| ~/.cargo/git/db/ | ||
| target/ | ||
| key: "cargo-build-linux-${{ steps.setup_rust.outputs.cachekey }}" | ||
| - name: Run sccache-cache | ||
| uses: mozilla-actions/[email protected] | ||
| - name: print tag | ||
| run: echo "ok we're publishing!" | ||
|
|
||
| - run: cargo build --release --locked | ||
| - run: strip target/release/obsidian-export | ||
| custom-publish-crate: | ||
| needs: [plan, should-publish] | ||
| if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }} | ||
| uses: ./.github/workflows/publish-crate.yml | ||
| with: | ||
| plan: ${{ needs.plan.outputs.val }} | ||
| secrets: inherit | ||
|
|
||
| - uses: actions/upload-artifact@v3 | ||
| # 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: | ||
| name: MacOS binary | ||
| path: target/release/obsidian-export | ||
| retention-days: 7 | ||
|
|
||
| - uses: actions/upload-release-asset@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| 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: | ||
| upload_url: ${{ needs.create-release.outputs.upload_url }} | ||
| asset_path: target/release/obsidian-export | ||
| asset_name: obsidian-export_MacOS-x86_64.bin | ||
| asset_content_type: application/octet-stream | ||
| 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/*" |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../CHANGELOG.md |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,4 +6,4 @@ | |
| ![[usage-library]] | ||
| ![[contribute]] | ||
| ![[license]] | ||
| ![[changelog]] | ||
| ![[changes]] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Changelog | ||
|
|
||
| For a list of releases and the changes with each version, please refer to [[CHANGES]]. | ||
| For a list of releases and the changes with each version, please refer to the [[CHANGELOG]]. |
Oops, something went wrong.