Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 3.92 KB
Raw

Contributing

Many thanks for taking the time to read this and for contributing to RoboStack!

This project is in early stages and we are looking for contributors to help it grow. The developers are on gitter where we discuss steps forward.

We welcome all kinds of contribution -- code or non-code -- and value them highly. We pledge to treat everyones contribution fairly and with respect and we are here to help awesome pull requests over the finish line.

Please note we have a code of conduct, and follow it in all your interactions with the project.

We follow the NumFOCUS code of conduct.

Adding new packages via pull requests

You can open a pull request that will get build automatically in our CI.

An example can be found here. Simply add the required packages to the vinca_*.yaml files, where the * indicates the desired platform (linux_64, osx, win or linux_aarch64). Ideally, try to add packages to all of these platforms.

Sometimes, it may be required to patch the packages. An example of how to do so can be found in this PR.

Testing changes locally

  1. Clone this repo: git clone https://github.com/RoboStack/ros-noetic.git
  2. cd ros-noetic
  3. conda env create -f env/robostackenv.yaml
  4. Make a symbolic link between your platform's yaml and vinca.yaml. Examples
  • ln -s vinca_linux_64.yaml vinca.yaml
  • ln -s vinca_osx.yaml vinca.yaml
  • mklink vinca.yaml vinca_win.yaml
  1. Modify your platform's yaml as you please, e.g. add new packages to be built.
  2. Run vinca to generate the recipe by executing vinca --multiple
  3. Move to the recipes folder to find the recipes that need to be (re)build: cd recipes. Note that at least one package needs to be (re)build for folder to show up.
  4. Build the recipes from within the recipes folder using boa: boa build . -m ../.ci_support/conda_forge_pinnings.yaml -m ../conda_build_config.yaml

How does it work?

  • The vinca.yaml file specifies which packages should be built.
    • Add the desired package under packages_select_by_deps. This will automatically pull in all dependencies of that package, too.
    • Note that all packages that are already build in one of the channels listed under skip_existing will be skipped. You can also add your local channel to that list by e.g. adding /home/ubuntu/miniconda3/conda-bld/linux-64/repodata.json.
    • If you want to manually skip packages, you can list them under packages_skip_by_deps.
    • If you set skip_all_deps to True, you will only build packages listed under packages_select_by_deps but none of their dependencies.
    • The packages_remove_from_deps list allows you to never build packages, even if they are listed as dependencies of other packages. We use it for e.g. the stage simulator which is not available in conda-forge, but is listed as one of the dependencies of the ros-simulator metapackage.
    • If you want to manually rebuild a package that already exists, you need to comment out the channels listed under skip_existing. You probably want to set skip_all_deps: true, otherwise all dependencies will be rebuilt in this case.
  • If the package does not build successfully out of the box, you might need to patch it. To do so, create a new file ros-noetic-$PACKAGENAME.patch in the patch directory (replace $PACKAGENAME$ with the name of the package, and replace any underscores with hyphens). You can also use platform specifiers to only apply the patch on a specific platform, e.g. ros-noetic-$PACKAGENAME.win.patch.
  • The robostack.yaml and packages-ignore.yaml files are the equivalent of the rosdep.yaml and translate ROS dependencies into conda package names (or in the case of the dependencies listed in packages-ignore.yaml the dependencies are ignored by specifying an empty list).