chore: Preparing to use 'dist' for more releases.

This relies on the upgrade to the latest version of 'dist'. Since we now have plugins that we want to produce pre-built binaries for, this updates our build configuration to support that. It'll need to be tested. Signed-off-by: Andrew Lilley Brinker <[email protected]>
mitre · Dec 4, 2024 · 764b5e1 · 764b5e1
1 parent 5de533f
commit 764b5e1
Show file tree

Hide file tree

Showing 60 changed files with 589 additions and 159 deletions.
diff --git a/.github/workflows/release-dry-run.yml b/.github/workflows/release-dry-run.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -63,7 +63,7 @@ jobs:
         # 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.25.1/cargo-dist-installer.sh | sh"
+        run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.26.0-prerelease.3/cargo-dist-installer.sh | sh"
       - name: Cache dist
         uses: actions/upload-artifact@v4
         with:
@@ -107,6 +107,7 @@ jobs:
       # - 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 }}
+    container: ${{ matrix.container && matrix.container.image || null }}
     env:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
@@ -117,8 +118,15 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
+      - name: Install Rust non-interactively if not already installed
+        if: ${{ matrix.container }}
+        run: |
+          if ! command -v cargo > /dev/null 2>&1; then
+            curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+            echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+          fi
       - name: Install dist
-        run: ${{ matrix.install_dist }}
+        run: ${{ matrix.install_dist.run }}
       # Get the dist-manifest
       - name: Fetch local artifacts
         uses: actions/download-artifact@v4
@@ -143,7 +151,7 @@ jobs:
         run: |
           # Parse out what we just built and upload it to scratch storage
           echo "paths<<EOF" >> "$GITHUB_OUTPUT"
-          jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
+          dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT"
           echo "EOF" >> "$GITHUB_OUTPUT"
 
           cp dist-manifest.json "$BUILD_MANIFEST_NAME"

diff --git a/Cargo.toml b/Cargo.toml
@@ -31,52 +31,22 @@ members = [
     "plugins/identity",
     "plugins/linguist",
     "plugins/review",
-    "plugins/typo"]
+    "plugins/typo",
+]
 
 # Make sure Hipcheck is run with `cargo run`.
 #
 # This means to use `xtask` with `cargo run` you need to specify the package.
 # See `.cargo/config.toml` for how this is done.
 default-members = ["hipcheck"]
 
-# Config for 'dist'
-[workspace.metadata.dist]
-# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
-cargo-dist-version = "0.25.1"
-# 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-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
-# Which actions to run on pull requests
-pr-run-mode = "plan"
-# Whether to install an updater program
-install-updater = true
-# Extra static files to include in each App (path relative to this Cargo.toml's dir)
-include = ["config/"]
-# Path that installers should place binaries in
-install-path = "CARGO_HOME"
-
-# Ubuntu build dependencies for `cargo-dist`
-[workspace.metadata.dist.dependencies.apt]
-protobuf-compiler = "*"
-
-# macOS build dependencies for 'cargo-dist'
-[workspace.metadata.dist.dependencies.homebrew]
-protobuf = "*"
-
-# Windows build dependencies for `cargo-dist`
-[workspace.metadata.dist.dependencies.chocolatey]
-protoc = "*"
-
 # The profile that 'cargo dist' will build with
-[profile.dist]
-
+#
 # For now this is just the release profile, but with "thin" Link-Time
 # Optimization enabled. This performs _some_ LTO and tries to hit the
 # right trade-off between the runtime performance improvements of more
 # LTO and the compile time cost of doing LTO.
+[profile.dist]
 inherits = "release"
 lto = "thin"
 

diff --git a/dist-workspace.toml b/dist-workspace.toml
@@ -0,0 +1,24 @@
+[workspace]
+
+# All the packages which 'cargo-dist' is responsible for.
+# This is _only_ the binary packages in the overall project, so it excludes
+# libraries including any SDKs and our supporting libraries.
+members = ["cargo:."]
+
+# Config for 'dist'
+[dist]
+# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.26.0-prerelease.3"
+# CI backends to support
+ci = "github"
+# Which actions to run on pull requests
+pr-run-mode = "plan"
+# Path that installers should place binaries in
+install-path = ["~/.local/bin", "~/.hipcheck/bin"]
+# Target platforms to build apps for (Rust target-triple syntax)
+targets = [
+    "aarch64-apple-darwin",
+    "x86_64-apple-darwin",
+    "x86_64-unknown-linux-gnu",
+    "x86_64-pc-windows-msvc",
+]
diff --git a/hipcheck/Cargo.toml b/hipcheck/Cargo.toml
@@ -156,8 +156,3 @@ which = { version = "7.0.0", default-features = false }
 
 dirs = "5.0.1"
 test-log = "0.2.16"
-
-[package.metadata.dist]
-
-# Make sure that `cargo-dist` can find this binary.
-dist = true
diff --git a/hipcheck/dist.toml b/hipcheck/dist.toml
@@ -0,0 +1,27 @@
+
+[dist]
+
+# Make sure that 'dist' will handle releases for this. Otherwise, since
+# the crate is set to 'publish = false', 'dist' would ignore it by default.
+dist = true
+
+# The installers to generate for each app
+installers = ["shell", "powershell"]
+
+# Whether to install an updater program
+install-updater = true
+
+# Make sure to include the configuration.
+include = ["../config/"]
+
+# Make sure that both Hipcheck and all the plugins are built with the protobuf
+# compiler present on their platform.
+
+[dist.dependencies.apt]
+protobuf-compiler = "*"
+
+[dist.dependencies.homebrew]
+protobuf = "*"
+
+[dist.dependencies.chocolatey]
+protoc = "*"
diff --git a/plugins/activity/Cargo.toml b/plugins/activity/Cargo.toml
@@ -3,6 +3,7 @@ name = "activity"
 version = "0.1.0"
 license = "Apache-2.0"
 edition = "2021"
+repository = "https://github.com/mitre/hipcheck"
 publish = false
 
 [dependencies]

diff --git a/plugins/activity/dist.toml b/plugins/activity/dist.toml
@@ -0,0 +1,17 @@
+
+[dist]
+
+# Make sure that 'dist' will handle releases for this. Otherwise, since
+# the crate is set to 'publish = false', 'dist' would ignore it by default.
+dist = true
+
+# We explicitly *don't* want 'dist' to produce installers; just to prebuild
+# the binaries for us and bundle everything together. Hipcheck itself will
+# handle people getting the prebuilt binaries based on the download manifest.
+installers = []
+
+# Do not install an updater.
+install-updater = false
+
+# Make sure to include the plugin manifest.
+include = ["plugin.kdl"]
diff --git a/plugins/activity/local-plugin.kdl b/plugins/activity/local-plugin.kdl
@@ -0,0 +1,15 @@
+publisher "mitre"
+name "activity"
+version "0.1.0"
+license "Apache-2.0"
+
+entrypoint {
+  on arch="aarch64-apple-darwin" "./target/debug/activity"
+  on arch="x86_64-apple-darwin" "./target/debug/activity"
+  on arch="x86_64-unknown-linux-gnu" "./target/debug/activity"
+  on arch="x86_64-pc-windows-msvc" "./target/debug/activity.exe"
+}
+
+dependencies {
+  plugin "mitre/git" version="0.1.0" manifest="./plugins/git/local-plugin.kdl"
+}
diff --git a/plugins/activity/plugin.kdl b/plugins/activity/plugin.kdl
@@ -2,12 +2,14 @@ publisher "mitre"
 name "activity"
 version "0.1.0"
 license "Apache-2.0"
+
 entrypoint {
-    on arch="aarch64-apple-darwin" "./target/debug/activity"
-    on arch="x86_64-apple-darwin" "./target/debug/activity"
-    on arch="x86_64-unknown-linux-gnu" "./target/debug/activity"
-    on arch="x86_64-pc-windows-msvc" "./target/debug/activity.exe"
+  on arch="aarch64-apple-darwin" "activity"
+  on arch="x86_64-apple-darwin" "activity"
+  on arch="x86_64-unknown-linux-gnu" "activity"
+  on arch="x86_64-pc-windows-msvc" "activity.exe"
 }
+
 dependencies {
-    plugin "mitre/git" version="0.1.0" manifest="./plugins/git/plugin.kdl"
+  plugin "mitre/git" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/git.kdl"
 }
diff --git a/plugins/affiliation/Cargo.toml b/plugins/affiliation/Cargo.toml
@@ -3,12 +3,13 @@ name = "affiliation"
 version = "0.1.0"
 license = "Apache-2.0"
 edition = "2021"
+repository = "https://github.com/mitre/hipcheck"
 publish = false
 
 [dependencies]
 anyhow = "1.0.91"
 clap = { version = "4.5.21", features = ["derive"] }
-hipcheck-sdk = { path = "../../sdk/rust", features = ["macros"]}
+hipcheck-sdk = { path = "../../sdk/rust", features = ["macros"] }
 kdl = "4.6.0"
 log = "0.4.22"
 pathbuf = "1.0.0"
@@ -19,4 +20,4 @@ strum = { version = "0.26.3", features = ["derive"] }
 tokio = { version = "1.41.1", features = ["rt"] }
 
 [dev-dependencies]
-hipcheck-sdk = { path = "../../sdk/rust", features = ["macros", "mock_engine"]}
+hipcheck-sdk = { path = "../../sdk/rust", features = ["macros", "mock_engine"] }
diff --git a/plugins/affiliation/dist.toml b/plugins/affiliation/dist.toml
@@ -0,0 +1,17 @@
+
+[dist]
+
+# Make sure that 'dist' will handle releases for this. Otherwise, since
+# the crate is set to 'publish = false', 'dist' would ignore it by default.
+dist = true
+
+# We explicitly *don't* want 'dist' to produce installers; just to prebuild
+# the binaries for us and bundle everything together. Hipcheck itself will
+# handle people getting the prebuilt binaries based on the download manifest.
+installers = []
+
+# Do not install an updater.
+install-updater = false
+
+# Make sure to include the plugin manifest.
+include = ["plugin.kdl"]
diff --git a/plugins/affiliation/local-plugin.kdl b/plugins/affiliation/local-plugin.kdl
@@ -0,0 +1,15 @@
+publisher "mitre"
+name "affiliation"
+version "0.1.0"
+license "Apache-2.0"
+
+entrypoint {
+  on arch="aarch64-apple-darwin" "./target/debug/affiliation"
+  on arch="x86_64-apple-darwin" "./target/debug/affiliation"
+  on arch="x86_64-unknown-linux-gnu" "./target/debug/affiliation"
+  on arch="x86_64-pc-windows-msvc" "./target/debug/affiliation.exe"
+}
+
+dependencies {
+  plugin "mitre/git" version="0.1.0" manifest="./plugins/git/local-plugin.kdl"
+}
diff --git a/plugins/affiliation/plugin.kdl b/plugins/affiliation/plugin.kdl
@@ -2,13 +2,14 @@ publisher "mitre"
 name "affiliation"
 version "0.1.0"
 license "Apache-2.0"
+
 entrypoint {
-  on arch="aarch64-apple-darwin" "./target/debug/affiliation"
-  on arch="x86_64-apple-darwin" "./target/debug/affiliation"
-  on arch="x86_64-unknown-linux-gnu" "./target/debug/affiliation"
-  on arch="x86_64-pc-windows-msvc" "./target/debug/affiliation.exe"
+  on arch="aarch64-apple-darwin" "affiliation"
+  on arch="x86_64-apple-darwin" "affiliation"
+  on arch="x86_64-unknown-linux-gnu" "affiliation"
+  on arch="x86_64-pc-windows-msvc" "affiliation.exe"
 }
 
 dependencies {
-  plugin "mitre/git" version="0.1.0" manifest="./plugins/git/plugin.kdl"
+  plugin "mitre/git" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/git.kdl"
 }
diff --git a/plugins/binary/Cargo.toml b/plugins/binary/Cargo.toml
@@ -3,12 +3,15 @@ name = "binary"
 version = "0.1.0"
 license = "Apache-2.0"
 edition = "2021"
+repository = "https://github.com/mitre/hipcheck"
 publish = false
 
 [dependencies]
 clap = { version = "4.5.21", features = ["derive"] }
 content_inspector = "0.2.4"
-hipcheck-sdk = { version = "0.1.0", path = "../../sdk/rust", features = ["macros"] }
+hipcheck-sdk = { version = "0.1.0", path = "../../sdk/rust", features = [
+    "macros",
+] }
 log = "0.4.22"
 pathbuf = "1.0.0"
 schemars = "0.8.21"

diff --git a/plugins/binary/dist.toml b/plugins/binary/dist.toml
@@ -0,0 +1,17 @@
+
+[dist]
+
+# Make sure that 'dist' will handle releases for this. Otherwise, since
+# the crate is set to 'publish = false', 'dist' would ignore it by default.
+dist = true
+
+# We explicitly *don't* want 'dist' to produce installers; just to prebuild
+# the binaries for us and bundle everything together. Hipcheck itself will
+# handle people getting the prebuilt binaries based on the download manifest.
+installers = []
+
+# Do not install an updater.
+install-updater = false
+
+# Make sure to include the plugin manifest.
+include = ["plugin.kdl"]
diff --git a/plugins/binary/local-plugin.kdl b/plugins/binary/local-plugin.kdl
@@ -0,0 +1,11 @@
+publisher "mitre"
+name "binary"
+version "0.1.0"
+license "Apache-2.0"
+
+entrypoint {
+  on arch="aarch64-apple-darwin" "./target/debug/binary"
+  on arch="x86_64-apple-darwin" "./target/debug/binary"
+  on arch="x86_64-unknown-linux-gnu" "./target/debug/binary"
+  on arch="x86_64-pc-windows-msvc" "./target/debug/binary.exe"
+}