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.

.github/workflows/publish-crate.yml

@@ -0,0 +1,19 @@
+name: Publish to crates.io
+
+on:
+  workflow_call:
+    inputs:
+      plan:
+        required: true
+        type: string
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    env:
+      PLAN: ${{ inputs.plan }}
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo publish

.github/workflows/release.yml

@@ -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*"
+      - '**[0-9]+.[0-9]+.[0-9]+*'
-
+  pull_request:
-env:
-  SCCACHE_GHA_ENABLED: "true"
-  RUSTC_WRAPPER: "sccache"
 
 jobs:
-  create-release:
+  # Run 'cargo dist plan' to determine what tasks we need to do
-    name: Create release
+  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/checkout@v4
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ${{ github.ref }}
+          submodules: recursive
-          release_name: ${{ github.ref }}
+      - name: Install cargo-dist
-          draft: true
+        run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.4.3/cargo-dist-installer.sh | sh"
-          prerelease: false
+      - 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-linux:
+  # Build and packages all the platform-specific things
-    name: Linux binary
+  upload-local-artifacts:
-    needs: create-release
+    # 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 }}
+      - 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"
+
+          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.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: 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<<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:
+          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:
-      - uses: actions/checkout@v4
+      - name: print tag
-      - uses: dtolnay/rust-toolchain@stable
+        run: echo "ok we're publishing!"
-        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/sccache-action@v0.0.3
 
-      - run: cargo build --release --locked
+  custom-publish-crate:
-      - run: strip target/release/obsidian-export
+    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
-        with:
+  publish-release:
-          name: Linux binary
+    needs: [plan, should-publish]
-          path: target/release/obsidian-export
+    runs-on: ubuntu-latest
-          retention-days: 7
+    env:
-
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        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
-
-  build-windows:
-    name: Windows binary
-    needs: create-release
-    runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-        id: setup_rust
-      - uses: actions/cache@v3
         with:
-          path: |
+          submodules: recursive
-            ~/.cargo/bin/
+      - name: "Download artifacts"
-            ~/.cargo/registry/index/
+        uses: actions/download-artifact@v3
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: "cargo-build-linux-${{ steps.setup_rust.outputs.cachekey }}"
-      - name: Run sccache-cache
-        uses: mozilla-actions/sccache-action@v0.0.3
-
-      - run: cargo build --release --locked
-      - run: strip target/release/obsidian-export.exe
-
-      - uses: actions/upload-artifact@v3
         with:
-          name: Windows binary
+          name: artifacts
-          path: target/release/obsidian-export.exe
+          path: artifacts
-          retention-days: 7
+      - name: Cleanup
-
+        run: |
-      - uses: actions/upload-release-asset@v1
+          # Remove the granular manifests
-        env:
+          rm artifacts/*-dist-manifest.json
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Release
+        uses: ncipollo/release-action@v1
         with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
+          tag: ${{ needs.plan.outputs.tag }}
-          asset_path: target/release/obsidian-export.exe
+          name: ${{ fromJson(needs.plan.outputs.val).announcement_title }}
-          asset_name: obsidian-export_Windows-x64_64.exe
+          body: ${{ fromJson(needs.plan.outputs.val).announcement_github_body }}
-          asset_content_type: application/octet-stream
+          prerelease: ${{ fromJson(needs.plan.outputs.val).announcement_is_prerelease }}
-
+          artifacts: "artifacts/*"
-  build-macos:
-    name: Mac OS binary
-    needs: create-release
-    runs-on: macos-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/sccache-action@v0.0.3
-
-      - run: cargo build --release --locked
-      - run: strip target/release/obsidian-export
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: MacOS binary
-          path: target/release/obsidian-export
-          retention-days: 7
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        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

Cargo.toml

@@ -46,3 +46,33 @@ pretty_assertions = "1.4.0"
 rstest = "0.18.2"
 tempfile = "3.8.1"
 walkdir = "2.4.0"
+
+# The profile that 'cargo dist' will build with
+[profile.dist]
+inherits = "release"
+lto = "thin"
+
+# 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.3"
+# 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 = [
+	#"aarch64-unknown-linux-gnu", # Not yet supported (2023-12-03)
+	"x86_64-unknown-linux-gnu",
+	#"x86_64-unknown-linux-musl",
+	"aarch64-apple-darwin",
+	"x86_64-apple-darwin",
+	# "aarch64-pc-windows-msvc",, # Not yet supported (2023-12-03)
+	"x86_64-pc-windows-msvc",
+]
+unix-archive = ".tar.xz"
+windows-archive = ".zip"
+# Publish jobs to run in CI
+pr-run-mode = "plan"
+# Publish jobs to run in CI
+publish-jobs = ["./publish-crate"]

README.md

@@ -30,10 +30,9 @@ It supports most but not all of Obsidian's Markdown flavor.
 
 ## Pre-built binaries
 
-Binary releases for x86-64 processors are provided for Windows, Linux and Mac operating systems on a best-effort basis.
+Pre-compiled binaries for all major platforms are available at <https://github.com/zoni/obsidian-export/releases>
-They are built with GitHub runners as part of the release workflow defined in `.github/workflows/release.yml`.
 
-The resulting binaries can be downloaded from <https://github.com/zoni/obsidian-export/releases>
+In addition to the installation scripts provided, these releases are also suitable for [installation with cargo-binstall](https://github.com/cargo-bins/cargo-binstall#readme).
 
 ## Building from source
 
@@ -265,7 +264,7 @@ Please review the [LICENSE] file for the full text of the license.
 
 # Changelog
 
-For a list of releases and the changes with each version, please refer to [CHANGES](CHANGES.md).
+For a list of releases and the changes with each version, please refer to the [CHANGELOG](CHANGELOG.md).
 
 [Obsidian]: https://obsidian.md/
 [CommonMark]: https://commonmark.org/

docs/CHANGELOG.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/CHANGES.md

@@ -1 +0,0 @@
-../CHANGES.md

docs/Release-checklist.md

@@ -2,6 +2,4 @@
 
 - [ ] Run `./make-new-release.sh`
 - [ ] Push the created release commit/tag to GitHub
-- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>)
+- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>) and confirm everything looks OK.
-- [ ] Run `cargo publish`
-- [ ] Publish drafted release (<https://github.com/zoni/obsidian-export/releases>)

docs/_combined.md

@@ -6,4 +6,4 @@
 ![[usage-library]]
 ![[contribute]]
 ![[license]]
-![[changelog]]
+![[changes]]

docs/changes.md

@@ -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]].

docs/installation.md

@@ -2,10 +2,9 @@
 
 ## Pre-built binaries
 
-Binary releases for x86-64 processors are provided for Windows, Linux and Mac operating systems on a best-effort basis.
+Pre-compiled binaries for all major platforms are available at <https://github.com/zoni/obsidian-export/releases>
-They are built with GitHub runners as part of the release workflow defined in `.github/workflows/release.yml`.
 
-The resulting binaries can be downloaded from <https://github.com/zoni/obsidian-export/releases>
+In addition to the installation scripts provided, these releases are also suitable for [installation with cargo-binstall][cargo-binstall].
 
 ## Building from source
 
@@ -24,3 +23,4 @@ If you downloaded a pre-built binary, upgrade by downloading the latest version
 If you built from source, upgrade by running `cargo install obsidian-export` again.
 
 [Cargo]: https://doc.rust-lang.org/cargo/
+[cargo-binstall]: https://github.com/cargo-bins/cargo-binstall#readme

make-new-release.sh

@@ -24,10 +24,10 @@ cargo check
 git commit "Cargo.*" --message "Release v${VERSION}"
 git tag "v${VERSION}"
 
-git cliff --latest --prepend CHANGES.md > /dev/null
+git cliff --latest --prepend CHANGELOG.md > /dev/null
-${EDITOR:-vim} CHANGES.md
+${EDITOR:-vim} CHANGELOG.md
 docs/generate.sh
-git add CHANGES.md README.md
+git add CHANGELOG.md README.md
 git commit --amend --no-edit
 git tag "v${VERSION}" --force