Skip to content

Commit 3f5f9a6

Browse files
Merge pull request #69 from RoboStack/traversaro-patch-1
Update commands for local testing
2 parents 097df82 + 6e052dc commit 3f5f9a6

File tree

1 file changed

+12
-31
lines changed

1 file changed

+12
-31
lines changed

Diff for: docs/Contributing.md

+12-31
Original file line numberDiff line numberDiff line change
@@ -45,45 +45,26 @@ To make code review easier, please consider manually porting the new hunks into
4545

4646
# Testing changes locally
4747

48-
```bash
49-
# First, create a new conda environment and add the conda-forge and robostack channels:
50-
51-
micromamba create -n robostackenv python=3.11
52-
53-
micromamba activate robostackenv
54-
micromamba config append channels conda-forge
55-
micromamba config append channels robostack-staging
56-
57-
# Install some dependencies
58-
micromamba install pip conda-build anaconda-client mamba conda catkin_pkg ruamel_yaml rosdistro empy networkx requests boa
59-
60-
# Install vinca
61-
pip install git+https://github.com/RoboStack/vinca.git --no-deps
62-
63-
# Clone the relevant repo
64-
git clone https://github.com/RoboStack/ros-humble.git # or: git clone https://github.com/RoboStack/ros-noetic.git
65-
66-
# Move in the newly cloned repo
67-
cd ros-humble # or: cd ros-noetic
48+
Clone the relevant repo:
6849

69-
# Make a copy of the relevant vinca file
70-
cp vinca_linux_64.yaml vinca.yaml # replace with your platform as necessary
50+
```bash
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
52+
```bash
7153
72-
# Now modify vinca.yaml as you please, e.g. add new packages to be built
73-
code vinca.yaml
54+
Then move in the newly cloned repo, and if necessary do any change to the `vinca_*.yaml` file for your platform:
7455
75-
# Run vinca to generate the recipe; the recipes will be located in the `recipes` folder
76-
vinca --multiple
56+
```bash
57+
cd ros-humble # or: cd ros-noetic or cd ros-jazzy
58+
```bash
7759
78-
# Build the recipe using boa:
79-
boa build recipes -m ./.ci_support/conda_forge_pinnings.yaml -m ./conda_build_config.yaml
60+
then you can build the packages that need to be built after the `vinca_***.yaml` changes with:
8061
81-
# You can also generate an azure pipeline locally, e.g.
82-
vinca-azure -d recipes -t mytriggerbranch -p linux-64
83-
# which will create a `linux.yml` file that contains the azure pipeline definition
62+
```bash
63+
pixi run build
8464
```
8565
8666
# How does it work?
67+
8768
- The `vinca.yaml` file specifies which packages should be built.
8869
- Add the desired package under `packages_select_by_deps`. This will automatically pull in all dependencies of that package, too.
8970
- The vinca.yaml files contain lots of commented-out package names. That is okay. Not all packages need to be rebuilt with every pull request. Do not be afraid if you see your package commented out after some time - it just means it is not being built now. For sure it will be built with next full rebuild. Full rebuilds happen occasionally (few times a year).

0 commit comments

Comments
 (0)