chore: Merge branch 'main' into feature/kvp-reorg

Author: Techassi

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+xtask = "run --package xtask --"

.gitattributes

@@ -1,2 +1,3 @@
+crates/stackable-operator/crds/*.yaml linguist-generated
 *.stderr linguist-generated
 *.snap linguist-generated

.github/ISSUE_TEMPLATE/config.yml

@@ -1,12 +1,9 @@
 ---
 blank_issues_enabled: true
 contact_links:
-  - name: Feature request
-    about: 🚀 Suggest an idea for this project
-    url: https://github.com/stackabletech/operator-rs/discussions/new?category=ideas
   - name: 🙋🏾 Question
     about: Use this to ask a question about this project
-    url: https://github.com/stackabletech/operator-rs/discussions/new?category=q-a
-  - name: Other issue
-    about: Open an issue that doesn't fit any other category
+    url: https://github.com/orgs/stackabletech/discussions/new?category=q-a
+  - name: 🚀 Feature Requests and other things
+    about: Open an issue with your feature request or any other issue not covered elsewhere
     url: https://github.com/stackabletech/operator-rs/issues/new

.github/ISSUE_TEMPLATE/release-workspace-members.md

@@ -1,7 +1,7 @@
 ---
 name: Pre-Release Workspace Member Updates and Releases
 about: This template can be used to track the updates and releases of all workspace members leading up to the next Stackable release
-title: "chore: Update and release workspace members"
+title: "chore: Update and release workspace members for Stackable Release YY.M.X"
 labels: ['epic']
 assignees: ''
 ---
@@ -11,7 +11,7 @@ assignees: ''
     This was created by an issue template: https://github.com/stackabletech/operator-rs/issues/new/choose.
 -->
 
-## Update and Release Workspace Members for Stackable Release XX.(X)X
+Part of stackabletech/issues#xxx.
 
 > [!NOTE]
 > During a Stackable release we update all dependencies in the `operator-rs`
@@ -21,15 +21,12 @@ assignees: ''
 
 Replace the items in the task lists below with the applicable Pull Requests
 
-```[tasklist]
-### Tasks
 - [ ] Update Rust version and workflow actions, see below for more details.
 - [ ] Update Rust dependencies, see below for more details.
 - [ ] Adjust and then verify crate versions using `.scripts/verify_crate_versions.sh`.
 - [ ] Push the release tags using `.scripts/tag_and_push_release.sh`.
-```
 
-### Update Rust Version and Workflow Actions
+## Update Rust Version and Workflow Actions
 
 > [!NOTE]
 > The PR is usually titled: `chore: Bump Rust version and workflow actions`
@@ -39,12 +36,13 @@ Replace the items in the task lists below with the applicable Pull Requests
 2. Adjust the version `RUST_TOOLCHAIN_VERSION` in the workflows:
      - `.github/workflows/build.yml`
      - `.github/workflows/pre_commit.yaml`
+     - `.github/workflows/publish-docs.yaml`
 3. Add a changelog entry.
 4. Update any actions (using the Git commit hash) in the workflows. Hint: Also
    make sure that the `cargo-udeps` action is up-to-date, otherwise the CI might
    report errors.
 
-### Update Rust Dependencies
+## Update Rust Dependencies
 
 > [!NOTE]
 > This PR is usually titled: `chore: Bump Rust dependencies`
@@ -58,7 +56,7 @@ Replace the items in the task lists below with the applicable Pull Requests
        override the dependency.
 5. Add a changelog entry if required.
 
-### Adjust and Verify Crate Versions
+## Adjust and Verify Crate Versions
 
 > [!WARNING]
 > Currently, all workspace members use `0.X.Y` versions. This means we can

.github/pull_request_template.md

@@ -7,24 +7,24 @@
 - Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
 - Please make sure all these things are done and tick the boxes
 
-```[tasklist]
-# Author
+### Author
+
 - [ ] Changes are OpenShift compatible
 - [ ] CRD changes approved
+- [ ] CRD documentation for all fields, following the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
 - [ ] Integration tests passed (for non trivial changes)
-```
+- [ ] Changes need to be "offline" compatible
+
+### Reviewer
 
-```[tasklist]
-# Reviewer
 - [ ] Code contains useful comments
+- [ ] Code contains useful logging statements
 - [ ] (Integration-)Test cases added
-- [ ] Documentation added or updated
+- [ ] Documentation added or updated. Follows the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
 - [ ] Changelog updated
 - [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
-```
 
-```[tasklist]
-# Acceptance
+### Acceptance
+
 - [ ] Feature Tracker has been updated
 - [ ] Proper release label has been added
-```

.github/workflows/build.yml

@@ -17,11 +17,13 @@ env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: '0'
   CARGO_PROFILE_DEV_DEBUG: '0'
-  RUST_TOOLCHAIN_VERSION: "1.80.1"
+  RUST_TOOLCHAIN_VERSION: "1.87.0"
   RUSTFLAGS: "-D warnings"
   RUSTDOCFLAGS: "-D warnings"
   RUST_LOG: "info"
 
+permissions: {}
+
 jobs:
   # Identify unused dependencies
   run_udeps:
@@ -30,14 +32,16 @@ jobs:
     env:
       RUSTC_BOOTSTRAP: 1
     steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
-      - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
+      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
         with:
           key: udeps
-      - run: cargo install --locked [email protected].50
+      - run: cargo install --locked [email protected].57
       - run: cargo udeps --all-targets --all-features
 
   run_cargodeny:
@@ -53,96 +57,50 @@ jobs:
     continue-on-error: ${{ matrix.checks == 'advisories' }}
 
     steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
-      - uses: EmbarkStudios/cargo-deny-action@3f4a782664881cf5725d0ffd23969fcce89fd868 # v1.6.3
-        with:
-          command: check ${{ matrix.checks }}
-
-  run_rustfmt:
-    name: Run Rustfmt
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
-          components: rustfmt
-      - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
-        with:
-          key: fmt
-      - run: cargo fmt --all -- --check
-
-  run_clippy:
-    name: Run Clippy
-    runs-on: ubuntu-latest
-    steps:
-      - name: Install host dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install protobuf-compiler krb5-user libkrb5-dev libclang-dev liblzma-dev libssl-dev pkg-config
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          submodules: recursive
-      - uses: dtolnay/rust-toolchain@master
+          persist-credentials: false
+      - uses: EmbarkStudios/cargo-deny-action@30f817c6f72275c6d54dc744fbca09ebc958599f # v2.0.12
         with:
-          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
-          components: clippy
-      - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
-        with:
-          key: clippy
-      - name: Run clippy action to produce annotations
-        # NOTE (@Techassi): This action might get a new release sonn, because it
-        # currently uses Node 16, which is deprecated in the next few months by
-        # GitHub. See https://github.com/giraffate/clippy-action/pull/87
-        uses: giraffate/clippy-action@13b9d32482f25d29ead141b79e7e04e7900281e0 # v1.0.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        if: env.GITHUB_TOKEN != null && github.event.pull_request.draft == false
-        with:
-          clippy_flags: --all-targets -- -D warnings
-          reporter: 'github-pr-review'
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Run clippy manually without annotations
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        if: env.GITHUB_TOKEN == null
-        run: cargo clippy --color never -q --all-targets -- -D warnings
+          command: check ${{ matrix.checks }}
 
   run_rustdoc:
     name: Run RustDoc
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
           components: rustfmt
-      - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
+      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
         with:
           key: doc
       - run: cargo doc --document-private-items
 
   run_tests:
     name: Run Cargo Tests
     needs:
-      - run_cargodeny
-      - run_clippy
-      - run_rustfmt
       - run_rustdoc
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
           # rust-src is required for trybuild stderr output comparison to work
           # for our cases.
           # See: https://github.com/dtolnay/trybuild/issues/236#issuecomment-1620950759
           components: rust-src
-      - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
+      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
         with:
           key: test
-      - run: cargo test --all-features
+      - run: cargo test --no-default-features --workspace
+      - run: cargo test --all-features --workspace
 
   tests_passed:
     name: All tests passed

.github/workflows/daily_security.yml

@@ -6,11 +6,15 @@ on:
     - cron: '15 4 * * *'
   workflow_dispatch:
 
+permissions: {}
+
 jobs:
   audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
-      - uses: rustsec/audit-check@dd51754d4e59da7395a4cd9b593f0ff2d61a9b95 # v1.4.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+      - uses: rustsec/audit-check@69366f33c96575abad1ee0dba8212993eecbe998 # v2.0.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr_pre-commit.yaml

@@ -3,42 +3,26 @@ name: pre-commit
 
 on:
   pull_request:
+  merge_group:
 
 env:
   CARGO_TERM_COLOR: always
-  RUST_TOOLCHAIN_VERSION: "1.80.1"
-  HADOLINT_VERSION: "v1.17.6"
+  RUST_TOOLCHAIN_VERSION: "nightly-2025-05-26"
+
+permissions: {}
 
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
+          persist-credentials: false
           fetch-depth: 0
-      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
-        with:
-          python-version: '3.12'
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
-          components: rustfmt,clippy
-      - name: Setup Hadolint
-        shell: bash
-        run: |
-          set -euo pipefail
-
-          LOCATION_DIR="$HOME/.local/bin"
-          LOCATION_BIN="$LOCATION_DIR/hadolint"
-
-          SYSTEM=$(uname -s)
-          ARCH=$(uname -m)
-
-          mkdir -p "$LOCATION_DIR"
-          curl -sL -o "${LOCATION_BIN}" "https://github.com/hadolint/hadolint/releases/download/${{ env.HADOLINT_VERSION }}/hadolint-$SYSTEM-$ARCH"
-          chmod 700 "${LOCATION_BIN}"
-
-          echo "$LOCATION_DIR" >> "$GITHUB_PATH"
-      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+      - uses: stackabletech/actions/run-pre-commit@4483641a7e24057bd2ba51cb4c3f2f0010ad21b7 # v0.8.4
         with:
-          extra_args: "--from-ref ${{ github.event.pull_request.base.sha }} --to-ref ${{ github.event.pull_request.head.sha }}"
+          rust: ${{ env.RUST_TOOLCHAIN_VERSION }}
+          # rust-src is required for trybuild stderr output comparison to work
+          # for our cases.
+          # See: https://github.com/dtolnay/trybuild/issues/236#issuecomment-1620950759
+          rust-components: rustfmt,clippy,rust-src

.github/workflows/publish-docs.yml

@@ -0,0 +1,56 @@
+---
+name: Publish Crate Docs
+
+# Once the `preview` input is available, this can also run on PR when docs are
+# changed.
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/publish-docs.yml
+      - crates/**
+
+env:
+  RUST_TOOLCHAIN_VERSION: "1.87.0"
+
+permissions: {}
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
+
+      - name: Build Crate Docs
+        run: cargo doc --no-deps --all-features
+
+      - name: Add Redirect
+        run: echo '<meta http-equiv="refresh" content="0;url=stackable_operator/index.html">' > target/doc/index.html
+
+      - name: Upload Documentation Artifacts
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+        with:
+          path: target/doc
+
+  publish-docs:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - name: Deploy to Github Pages
+        id: deploy
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5