Merge branch 'main' into 2024-09-create-kube-configs-stepthru

Author: m3dwards

.github/workflows/test.yml

@@ -16,20 +16,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: eifinger/setup-uv@v1
-      - run: uvx ruff --version
-      - run: uvx ruff check .
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.4"
+          enable-cache: true
+      - run: uvx [email protected] check .
 
   ruff-format:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v2
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v3
         with:
-          version: "latest"
+          version: "0.4.4"
           enable-cache: true
-      - run: uvx ruff format . --check
+      - run: uvx ruff@0.6.8 format . --check
 
   test:
     needs: [ruff, ruff-format]

docs/developer-notes.md

@@ -21,15 +21,27 @@ pip install --upgrade pip
 pip install -e .
 ```
 
-## Lint
+## Formatting & linting
 
 This project primarily uses the `uv` python packaging tool: https://docs.astral.sh/uv/ along with the sister formatter/linter `ruff` https://docs.astral.sh/ruff/
 
+Refer to the `uv` documentation for installation methods: https://docs.astral.sh/uv/getting-started/installation/
+
 With `uv` installed you can add/remove dependencies using `uv add <dep>` or `uv remove <dep>.
 This will update the [`uv.lock`](https://docs.astral.sh/uv/guides/projects/#uvlock) file automatically.
 
+We use ruff version 0.6.8 in this project currently. This can be installed as a stand-alone binary (see documentation), or via `uv` using:
+
+```bash
+# install
+$ uv tool install [email protected]
+
+# lint
+$ uvx [email protected] check .
 
-`uv` can also run tools (like `ruff`) without external installation, simply run `uvx ruff check .` or `uvx ruff format .` to use a uv-managed format/lint on the project.
+# format
+$ uvx [email protected] format .
+```
 
 ## Release process
 
@@ -59,4 +71,4 @@ python3 -m build
 ```bash
 # Upload to Pypi
 python3 -m twine upload dist/*
-```
+```

ruff.toml

@@ -1,3 +1,4 @@
+required-version = "==0.6.8"
 extend-exclude = [
     "resources/scenarios/test_framework",
     "resources/images/exporter/authproxy.py",