Skip to content

Commit 7e46e9f

Browse files
authored
Merge branch 'master' into docs/improve-pixi-docs
2 parents fbd3d08 + 5323c60 commit 7e46e9f

File tree

10 files changed

+1841
-351
lines changed

10 files changed

+1841
-351
lines changed

.github/workflows/update-package-table.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ jobs:
2828
- name: Create table jazzy
2929
run: |
3030
pixi run compare-completeness jazzy robostack-jazzy
31+
- name: Create table kilted
32+
run: |
33+
pixi run compare-completeness kilted robostack-kilted
3134
- name: Commit changes
3235
id: commit
3336
run: |
@@ -38,6 +41,7 @@ jobs:
3841
git add docs/galactic.md
3942
git add docs/humble.md
4043
git add docs/jazzy.md
44+
git add docs/kilted.md
4145
git commit -m "Update tables"
4246
continue-on-error: true
4347
- name: Push changes

docs/Contributing.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ Sometimes, it may be required to patch the packages. An example of how to do so
3030
6. Create a patch file with `git diff > changes.patch`
3131
7. Check that the patch contains the intended changes
3232
8. Move the file into the `patches` directory of this repository, renaming it according to the naming convention. If the changes are portable across all supported operating system, the file should be called `<package name>.patch`; otherwise, `<package name>.<win/linux/osx>.patch`
33-
9. Rerun `pixi run build` to ensure that the patching succeeds and the package builds without errors
34-
10. Commit the new file, push to your fork and create a PR
33+
9. In some cases the `recipe.yaml` generated needs also a patch (eg. add a conda dependency), in those scenarios a `add_host` key needs to be added to `patch/dependencies.yaml` [example](https://github.com/RoboStack/ros-noetic/blob/bd1d2f44fcbfb02a31c464e51a761fb0fdc32ec0/patch/dependencies.yaml#L15-L17)
34+
10. Rerun `pixi run build` to ensure that the patching succeeds and the package builds without errors
35+
11. Commit the new file, push to your fork and create a PR
3536

3637
## Extending an existing patch file
3738

@@ -47,13 +48,13 @@ To make code review easier, please consider manually porting the new hunks into
4748
Clone the relevant repo:
4849

4950
```bash
50-
git clone https://github.com/RoboStack/ros-humble.git # or: git clone https://github.com/RoboStack/ros-noetic.git or git clone https://github.com/RoboStack/ros-jazzy.git
51+
git clone https://github.com/RoboStack/ros-humble.git # or: git clone https://github.com/RoboStack/ros-noetic.git or git clone https://github.com/RoboStack/ros-jazzy.git or git clone https://github.com/RoboStack/ros-kilted.git
5152
```bash
5253
5354
Then move in the newly cloned repo, and if necessary do any change to the `vinca_*.yaml` file for your platform:
5455
5556
```bash
56-
cd ros-humble # or: cd ros-noetic or cd ros-jazzy
57+
cd ros-humble # or: cd ros-noetic or cd ros-jazzy or cd ros-kilted
5758
```bash
5859
5960
then you can build the packages that need to be built after the `vinca_***.yaml` changes with:

docs/GettingStarted.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
3030
=== "Mamba"
3131

3232
```bash title="Prepare an environment to use the correct channels"
33-
mamba create -n ros_env python=3.11
33+
mamba create -n ros_env
3434
mamba activate ros_env
3535

3636
# this adds the conda-forge channel to the new created environment configuration
@@ -56,6 +56,11 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
5656
mamba install ros-jazzy-desktop
5757
```
5858

59+
=== "ROS2 Kilted"
60+
```
61+
conda config --env --add channels robostack-kilted
62+
mamba install ros-kilted-desktop
63+
```
5964

6065
```bash title="Deactivate and reactivate the environment to initialize the configured ROS environment"
6166
mamba deactivate
@@ -91,6 +96,14 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
9196
micromamba activate ros_env
9297
```
9398

99+
=== "ROS2 Kilted"
100+
```
101+
# Create a ros-kilted desktop environment
102+
micromamba create -n ros_env -c conda-forge -c robostack-kilted ros-kilted-desktop
103+
104+
# Activate the environment
105+
micromamba activate ros_env
106+
```
94107

95108
## Installing tools for local development
96109
=== "Mamba"
@@ -166,7 +179,7 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
166179
version = "0.1.0"
167180
description = "Development environment for RoboStack ROS packages"
168181
authors = ["Your Name <your.email@example.com>"]
169-
channels = ["https://fast.prefix.dev/conda-forge"]
182+
channels = ["https://prefix.dev/conda-forge"]
170183
platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"]
171184

172185
# This will automatically activate the ros workspace on activation
@@ -203,6 +216,7 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
203216
noetic = { features = ["noetic"] }
204217
humble = { features = ["humble"] }
205218
jazzy = { features = ["jazzy"] }
219+
kilted = { features = ["kilted"] }
206220

207221
# noetic
208222
[feature.noetic]
@@ -251,6 +265,15 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
251265
colcon-common-extensions = "*"
252266
rosdep = "*"
253267

268+
# kilted
269+
[feature.kilted]
270+
channels = ["https://prefix.dev/robostack-kilted"]
271+
272+
[feature.kilted.dependencies]
273+
ros-kilted-desktop = "*"
274+
colcon-common-extensions = "*"
275+
rosdep = "*"
276+
254277
# To build you can use - pixi run -e jazzy build <Any other temporary args>
255278
[feature.jazzy.target.win-64.tasks]
256279
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
@@ -261,6 +284,7 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
261284
[feature.jazzy.target.linux-aarch64.tasks]
262285
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
263286
```
287+
264288
```bash
265289
# Save and exit pixi.toml
266290
pixi install
@@ -274,6 +298,9 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
274298

275299
# ROS jazzy
276300
pixi shell -e jazzy
301+
302+
# ROS kilted
303+
pixi shell -e kilted
277304
```
278305

279306
## Testing installation
@@ -391,12 +418,12 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
391418
**ROS2**
392419
```bash title="Terminal"
393420
cd robostack
394-
pixi run -e humble rviz2 # OR jazzy
421+
pixi run -e humble rviz2 # OR jazzy, kilted
395422
```
396423
alternatively,
397424
```bash title="Terminal"
398425
cd robostack
399-
pixi shell -e humble # OR jazzy
426+
pixi shell -e humble # OR jazzy, kilted
400427
rviz2
401428
```
402429

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy