feat: Add boil tool (#1224)

* feat: Add boil tool

* chore: Add boil configs and adjust Dockerfiles

* chore: Remove old Python config files

* ci: Adjust notification condition

Only send out notifications if the build failed, a build is re-run
and wasn't cancelled.

* chore: Remove commented-out code

* chore: Remove unwraps

* chore: Add cargo alias for boil

* chore: Update README to mention boil

* chore: Update README

* feat: Add --load flag to build command

* feat: Add more annotations to the built image

* fix: Apply corrections from code review

There were a bunch of small errors in the new boil-config.toml files. These are now fixed and should contain the same data as the versions.py files before.

Co-authored-by: Xenia <[email protected]>

* chore: Remove protobuf-version arg from Hadoop boil config

* feat: List images to show, move CLI arguments

* chore: Add example to README

* feat: Move shared data into common target which targets inherit from

* chore: Add rust-toolchain file

* chore: Make config arg global

* feat: Add --strip-architecture arg

* ci: Add workflow to release boil

* ci: Also build boil on PR (without releasing it)

* ci: Remove reusable workflow

* ci: Only build boil for aarch64 on macOS

* chore: Remove the term "product" from the Rust source code

* feat: Add CLI argument to load build argumnts from file

* chore: Add metadata to Cargo.toml files

* chore: Add rustfmt config, apply changes

* chore: Adjust pre-commit config file

* ci: Add cargo-deny job to workflow

* chore: Bump tracing-subscriber to 0.3.20 to fix RUSTSEC-2025-0055

* chore: Add metadata to patchable's Cargo.toml file

* ci: Still build boil on PR

* ci: Install Rust in pre-commit workflow

* chore: Use Apache-2.0 license instead of OSL-3.0 license

* chore: Mention nightly Rust toolchain updates

* chore: Remove OpenShift arg

* chore: Remove tree subcommand (for now)

* chore: Move glob pattern into const

* chore: Add more image validation

* chore: Add image config file name constant

* chore: Move Docker label into a constant

* fix: Actually use --target-containerfile argument

* docs: Add doc comments for clap command handler functions

* feat: Auto-detect interactive shell for pretty output

* chore: Only use a single output format

* chore: Remove unused code

* chore: Rename --export-image-manifest-uris CLI argument

* chore: Apply suggestions

Co-authored-by: Nick <[email protected]>

* docs: Add some clarifying doc comments

* feat: Improve image parsing and validation

* chore: Update slab to 0.4.11 to fix RUSTSEC-2025-0047

See https://rustsec.org/advisories/RUSTSEC-2025-0047

---------

Co-authored-by: Xenia <[email protected]>
Co-authored-by: Nick <[email protected]>

Author: 3 people

.cargo/config.toml

@@ -1,2 +1,3 @@
 [alias]
 patchable = ["run", "--bin", "patchable", "--"]
+boil = ["run", "--bin", "boil", "--"]

.github/workflows/boil_build_release.yaml

@@ -0,0 +1,92 @@
+---
+name: Build/Release boil
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/boil_build_release.yaml'
+      - 'rust-toolchain.toml'
+      - 'Cargo.*'
+      - '**.rs'
+  push:
+    tags:
+      - "boil-[0-9]+.[0-9]+.[0-9]+**"
+
+env:
+  RUST_VERSION: 1.87.0
+
+jobs:
+  # This job is always run to ensure we don't miss any new upstream advisories
+  cargo-deny:
+    name: Run cargo-deny
+    runs-on: ubuntu-latest
+    # Prevent sudden announcement of a new advisory from failing CI
+    continue-on-error: ${{ matrix.checks == 'advisories' }}
+    strategy:
+      matrix:
+        checks:
+          - advisories
+          - bans licenses sources
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+          submodules: recursive
+
+      - name: Run cargo-deny
+        uses: EmbarkStudios/cargo-deny-action@f2ba7abc2abebaf185c833c3961145a3c275caad # v2.0.13
+        with:
+          command: check ${{ matrix.checks }}
+
+  create-release:
+    name: Create Draft Release
+    if: github.event_name == 'push'
+    needs:
+      - cargo-deny
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create Draft Release
+        uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8 # v2.3.2
+        with:
+          draft: true
+
+  build:
+    name: Build boil
+    needs:
+      - cargo-deny
+    strategy:
+      fail-fast: false
+      matrix:
+        targets:
+          - {target: aarch64-unknown-linux-gnu, os: ubuntu-24.04-arm}
+          - {target: x86_64-unknown-linux-gnu, os: ubuntu-latest}
+          - {target: aarch64-apple-darwin, os: macos-latest}
+    runs-on: ${{ matrix.targets.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+          targets: ${{ matrix.targets.target }}
+
+      - name: Build Binary
+        env:
+          TARGET: ${{ matrix.targets.target }}
+        run: cargo build --target "$TARGET" --release --package boil
+
+      - name: Rename Binary
+        env:
+          TARGET: ${{ matrix.targets.target }}
+        run: mv "target/$TARGET/release/boil" "boil-$TARGET"
+
+      - name: Upload Artifact to Release
+        if: github.event_name == 'push'
+        uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8 # v2.3.2
+        with:
+          draft: false
+          files: boil-${{ matrix.targets.target }}

.github/workflows/pr_pre-commit.yaml

@@ -5,6 +5,8 @@ on:
   pull_request:
 
 env:
+  # Keep in sync with across other repos like operator-rs and operator-templating
+  RUST_TOOLCHAIN_VERSION: "nightly-2025-05-26"
   HADOLINT_VERSION: "v2.12.0"
   PYTHON_VERSION: "3.12"
 
@@ -19,4 +21,5 @@ jobs:
       - uses: stackabletech/actions/run-pre-commit@497f3e3cbfe9b89b1e570351b97d050eebcad5d0 # 0.8.3
         with:
           python-version: ${{ env.PYTHON_VERSION }}
+          rust: ${{ env.RUST_TOOLCHAIN_VERSION }}
           hadolint: ${{ env.HADOLINT_VERSION }}

.github/workflows/reusable_build_image.yaml

@@ -102,7 +102,7 @@ jobs:
     name: Failure Notification
     needs: [generate_matrix, build, publish_manifests]
     runs-on: ubuntu-latest
-    if: failure() || github.run_attempt > 1
+    if: failure() || (github.run_attempt > 1 && !cancelled())
     steps:
       - name: Send Notification
         uses: stackabletech/actions/send-slack-notification@55d2f9fcbcd7884ac929ea65fd6f069e7b7a49d2 # v0.8.1

.pre-commit-config.yaml

@@ -60,3 +60,27 @@ repos:
         entry: .scripts/update_readme_badges.sh
         stages: [pre-commit, pre-merge-commit, manual]
         pass_filenames: false
+
+      - id: cargo-test
+        name: cargo-test
+        language: system
+        entry: cargo test
+        stages: [pre-commit, pre-merge-commit]
+        pass_filenames: false
+        files: \.rs$|Cargo\.(toml|lock)
+
+      - id: cargo-rustfmt
+        name: cargo-rustfmt
+        language: system
+        entry: cargo +nightly-2025-05-26 fmt --all -- --check
+        stages: [pre-commit, pre-merge-commit]
+        pass_filenames: false
+        files: \.rs$
+
+      - id: cargo-clippy
+        name: cargo-clippy
+        language: system
+        entry: cargo clippy --all-targets -- -D warnings
+        stages: [pre-commit, pre-merge-commit]
+        pass_filenames: false
+        files: \.rs$

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "rust-analyzer.rustfmt.overrideCommand": [
+    "rustfmt",
+    // Keep in sync with across other repos like operator-rs and operator-templating
+    "+nightly-2025-05-26",
+    "--edition",
+    "2024",
+    "--"
+  ],
+}