feat: Add CRD previewer (#1030)

* feat: Add CRD previewer

* Add DummyCluster

* docs

* Add comment

* Fixup DummyServer

* Add README

* Add CI check

* Fix CI

* Add changelog

* Fix versions script

* fix: Dont leak rustdoc in CRD descriptions

* update crds

* refactor: Transform CRD preview into xtask

* ci: Remove unused job in build workflow

* chore: Update ListenerClass CRD

* chore: Cleanup schemars derive

---------

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

Author: sbernauer

.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

.pre-commit-config.yaml

@@ -12,11 +12,6 @@ repos:
         args: ["--allow-missing-credentials"]
       - id: detect-private-key
 
-  - repo: https://github.com/doublify/pre-commit-rust
-    rev: eeee35a89e69d5772bdee97db1a6a898467b686e # 1.0
-    hooks:
-      - id: clippy
-        args: ["--all-targets", "--", "-D", "warnings"]
   - repo: https://github.com/adrienverge/yamllint
     rev: 79a6b2b1392eaf49cdd32ac4f14be1a809bbd8f7 # 1.37.1
     hooks:
@@ -52,10 +47,27 @@ repos:
         stages: [pre-commit, pre-merge-commit, manual]
         pass_filenames: false
 
-      - id: rustfmt
-        name: rustfmt
+      - id: cargo-rustfmt
+        name: cargo-rustfmt
         language: system
         # Pinning to a specific rustc version, so that we get consistent formatting
         entry: cargo +nightly-2025-05-26 fmt --all -- --check
-        stages: [pre-commit]
+        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$
+
+      - id: crd-preview
+        name: crd-preview
+        language: system
+        entry: cargo xtask crd preview
+        stages: [pre-commit, pre-merge-commit]
         pass_filenames: false
+        files: \.rs$

.scripts/verify_crate_versions.sh

@@ -12,6 +12,10 @@ set -euo pipefail
 # stackable-webhook-0.3.1
 
 for CRATE in $(find ./crates/ -mindepth 2 -name Cargo.toml -print0 | xargs -0 -n 1 dirname | xargs -n 1 basename | sort); do
+    if [ "$CRATE" = "xtask" ]; then
+        continue # Skip xtask binary, because it is not published and only used for internal tooling
+    fi
+
     # Get the version in Cargo.toml
     CRATE_VERSION=$(grep 'version' "./crates/$CRATE/Cargo.toml" | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -1)
     [ -n "$CRATE_VERSION" ] || (
@@ -40,7 +44,6 @@ for CRATE in $(find ./crates/ -mindepth 2 -name Cargo.toml -print0 | xargs -0 -n
             echo "Ensure the version in ./crates/$CRATE/Cargo.toml matches the version in ./crates/$ASSOCIATED_CRATE/Cargo.toml" >&2
             exit 23
         )
-
     else
         # Get the latest documented version from the CHANGELOG.md
         CHANGELOG_VERSION=$(grep -oE '\[[0-9]+\.[0-9]+\.[0-9]+\]' "./crates/$CRATE/CHANGELOG.md" | head -1 | tr -d '[]')

.yamllint.yaml

@@ -7,3 +7,6 @@ rules:
     check-keys: false
   comments:
     min-spaces-from-content: 1  # Needed due to https://github.com/adrienverge/yamllint/issues/443
+  indentation:
+    ignore:
+      crates/stackable-operator/crds/*.yaml