Merge remote-tracking branch 'origin/main' into fix/docs

Author: jaagut

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/pull_request_template.md

@@ -7,11 +7,11 @@
 ## Related issues
 <!--- Mention (link) related issues. -->
 <!--- If you suggest a new feature, please discuss it in an issue first. -->
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce. -->
 
 ## Checklist
 
-- [ ] Run `just build`
+- [ ] Run `pixi run build`
 - [ ] Write documentation
 - [ ] Test on your machine
 - [ ] Test on the robot

.github/workflows/ci.yml

@@ -1,7 +1,7 @@
 name: Build & Test
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '12 3 * * *'
   push:
 
 jobs:
@@ -12,7 +12,7 @@ jobs:
 
     steps:
       - name: Cancel outdated jobs
-        uses: fkirc/skip-duplicate-actions@v5
+        uses: fkirc/skip-duplicate-actions@v5.3.1
         with:
           cancel_others: 'true'
 
@@ -23,7 +23,7 @@ jobs:
       #     detached: true
 
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6.0.2
 
       - name: Configure git to trust repository
         run: git config --global --add safe.directory /__w/bitbots_main/bitbots_main
@@ -32,7 +32,7 @@ jobs:
         run: scripts/make_basler.sh --ci
 
       - name: Set up workspace
-        uses: prefix-dev/setup-pixi@v0.9.3
+        uses: prefix-dev/setup-pixi@v0.9.5
         with:
           pixi-version: v0.63.1
           cache: true

.github/workflows/pre-commit.yml

@@ -5,13 +5,13 @@ on:
 
 jobs:
   pre-commit:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-slim
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up workspace
-        uses: prefix-dev/setup-pixi@v0.9.3
+        uses: prefix-dev/setup-pixi@v0.9.5
         with:
           pixi-version: v0.59.0
           cache: true

.pre-commit-config.yaml

@@ -1,3 +1,9 @@
+exclude: |
+  (?x)(
+    ^src/lib/|
+    ^src/bitbots_team_communication/bitbots_team_communication/bitbots_team_communication/RobocupProtocol/
+  )
+
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.9.6
@@ -14,7 +20,6 @@ repos:
         args:
           - "-i"
       - id: cppcheck
-        exclude: &exclude_robocup_protocol ^src/bitbots_team_communication/bitbots_team_communication/bitbots_team_communication/RobocupProtocol/
         args:
           - "--inline-suppr"
           - "--suppress=missingIncludeSystem"
@@ -28,13 +33,11 @@ repos:
     hooks:
       - id: cmake-format
       - id: cmake-lint
-        exclude: *exclude_robocup_protocol
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
       - id: check-merge-conflict
       - id: check-toml
       - id: check-xml
       - id: check-yaml
-        exclude: *exclude_robocup_protocol
       - id: detect-private-key

.rsyncignore

@@ -17,6 +17,7 @@ src/bitbots_misc/bitbots_parameter_blackboard/config/game_settings.yaml
 *.idea
 *.pyc
 *.vscode
+*.devcontainer
 
 __pycache__
 

.vscode/extensions.json

@@ -18,11 +18,11 @@
         "ms-vscode.cpptools-themes", // C++ support
         "ms-vscode.cpptools", // C++ support
         "njpwerner.autodocstring", // Generates docstrings
+        "Plex.vscode-protolint", // Protobuf support
         "streetsidesoftware.code-spell-checker-german", // Spell checker
         "streetsidesoftware.code-spell-checker", // Spell checker
         "tamasfe.even-better-toml", // TOML support
         "trond-snekvik.simple-rst", // Syntax highlighting for rst files
         "twxs.cmake", // CMake support
-        "zxh404.vscode-proto3", // Protobuf support
     ]
 }

README.md

@@ -15,7 +15,19 @@ All code is written as individual ROS 2 packages.
 
 The workspace is managed using the [pixi](https://pixi.sh) package manager. This allows us to have reproducible builds and easy user space dependency management similar to tools like `uv` or `cargo`. This also means that no system wide ROS installation or superuser privileges are required to install or run the code.
 
-Follow our [installation guide](https://docs.bit-bots.de/meta/manual/tutorials/installation.html) for a quick installation or step-by-step instructions.
+Full step-by-step instructions for installing the Bit-Bots software stack and ROS 2 can be found in our [documentation](https://docs.bit-bots.de/meta/manual/tutorials/install_software_ros2.html).
+
+Run the following command inside this repository to build the workspace.
+All dependencies will be installed automatically.
+Make sure you have [pixi](https://pixi.sh) installed.
+A few optional proprietary dependencies will be needed for full functionality, see the documentation for details.
+
+``` shell
+pixi run build
+```
+
+The first build might fail due to missing dependencies.
+Run `pixi run basler` to install the Basler pylon camera driver.
 
 ## Using the workspace