Skip to content

Commit 64f2742

Browse files
authored
Add docs on full rebuild to contributing.md
1 parent dc97770 commit 64f2742

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/Contributing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,15 @@ pixi run build
7070
- The `packages_remove_from_deps` list allows you to never build packages, even if they are listed as dependencies of other packages, by removing them from the 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.
7171
- If you want to rebuild a package (for example because it had a problem for which you added a patch), set it build number explicitly in the `pkg_additional_info.yaml` file. Note that this will not update the package, unless the `rosdistro_snapshot.yaml` file is also updated (and that typically happens only for full rebuild)
7272
- The `robostack.yaml` and `packages-ignore.yaml` files are the equivalent of the [rosdep.yaml](http://wiki.ros.org/rosdep/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).
73+
74+
# Doing a full rebuild
75+
76+
A "full rebuild" is a rebuild of all packages for a given distro, that is tipically done to update the version of ROS packages contained in a robostack channel, and to build against new version of dependencies provided by conda-forge.
77+
78+
When doing a full rebuild, please follow this guidelines:
79+
- Refresh the rosdistro_snapshot.yaml by running vinca snapshot (this is the only step that actually queries rosdistro, directly from the repo and indipendently from sync).
80+
- Refresh the conda_build_config.yaml file to reflect the current status of conda-forge plus migrations that are basically finished even if not updated in conda-forge-pinnings (if in doubt, ask to mantainers).
81+
- Bump the build_number in `vinca_*.yaml` files to a version higher then any existing build number (considering the overriden build numbers in pkg_additional_info.yaml).
82+
- Bump the minor number of the mutex_package in `vinca_*.yaml`, and manually search for any hardcoded number for `ros-distro-mutex` or `ros2-distro-mutex` in `additional_recipes`
83+
- Remove any build_number override in pkg_additional_info.yaml.
84+

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