Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document required apt dependencies in machine readable format with apt.txt file #825

Merged
merged 13 commits into from
Jul 15, 2021

Conversation

traversaro
Copy link
Member

@traversaro traversaro commented Jul 14, 2021

A trend that we noticed in the latest years was that the long list of apt dependencies of the superbuild tended to be duplicated in many places (Docker image recipes, documentation pages on how to install the superbuild). This clearly created problem anytime the list of dependencies changed, as all the hardcoded copies of the list were outdated and needed to be manually updated.

To solve this problem, this PR does the following:

  • The main apt dependencies of the superbuild (the one documented in the main readme as dependencies of the superbuild as an whole) are now stored in the apt.txt file in the root of the repo (convention copied by repo2docker, see https://repo2docker.readthedocs.io/en/latest/config_files.html#apt-txt-install-packages-with-apt-get). The rest of dependencies that are required only for specific options are instead still documented manually, but I noticed that in practice those dependencies are much less used.
  • Instead of the manual list of dependencies, now the README suggest to run the sudo bash ./scripts/install_apt_dependencies.sh script to install the dependencies, that just install via apt-get all the dependncies listed in the apt.txt file.

This change will be released first in Distro Release 2021.08, so unfortunatly it will be possible to use it only from that point on.

@traversaro traversaro requested review from Nicogene and S-Dafarra July 14, 2021 12:14
apt.txt Outdated Show resolved Hide resolved
traversaro and others added 2 commits July 14, 2021 14:48
Co-authored-by: Stefano Dafarra <stefano.dafarra@gmail.com>
@traversaro
Copy link
Member Author

fyi @pattacini

@traversaro traversaro merged commit dae8b3f into master Jul 15, 2021
@traversaro traversaro deleted the add-apt-txt branch July 15, 2021 08:45
@pattacini
Copy link
Member

Nice feature!

Nicogene pushed a commit to Nicogene/robotology-superbuild that referenced this pull request Feb 14, 2022
…t.txt file (robotology#825)

Co-authored-by: Stefano Dafarra <stefano.dafarra@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants