From 1e00be8d4a435ffc5ee8aca9b303dd0660f17d4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=2E=20Fatih=20C=C4=B1r=C4=B1t?= Date: Tue, 19 Nov 2024 15:43:41 +0300 Subject: [PATCH 1/2] docs(installation): add information about nightly.repos MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: M. Fatih Cırıt --- .../autoware/docker-installation.md | 14 ++++++++++++ .../autoware/source-installation.md | 22 +++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 474b5ff714..1dfd58cf34 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -88,6 +88,14 @@ Inside the container, you can run the Autoware tutorials by following these link vcs import src < autoware.repos ``` + If you are an active developer, you may also want to pull the nightly repositories, which contain the latest updates: + + ```bash + vcs import src < autoware-nightly.repos + ``` + + > ⚠️ Note: The nightly repositories are unstable and may contain bugs. Use them with caution. + 2. Update dependent ROS packages. The dependencies of Autoware may have changed after the Docker image was created. @@ -114,6 +122,10 @@ Inside the container, you can run the Autoware tutorials by following these link > cd autoware > git pull > vcs import src < autoware.repos +> +> # If you are using nightly repositories, also run the following command: +> vcs import src < autoware-nightly.repos +> > vcs pull src > # Make sure all ros-$ROS_DISTRO-* packages are upgraded to their latest version > sudo apt update && sudo apt upgrade @@ -128,6 +140,8 @@ Inside the container, you can run the Autoware tutorials by following these link > ```bash > rm -rf src/* > vcs import src < autoware.repos +> # If you are using nightly repositories, import them as well. +> vcs import src < autoware-nightly.repos > ``` #### Using VS Code remote containers for development diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index 2c389ab5b2..3c216fccbe 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -81,6 +81,14 @@ sudo apt-get -y install git vcs import src < autoware.repos ``` + If you are an active developer, you may also want to pull the nightly repositories, which contain the latest updates: + + ```bash + vcs import src < autoware-nightly.repos + ``` + + > ⚠️ Note: The nightly repositories are unstable and may contain bugs. Use them with caution. + 2. Install dependent ROS packages. Autoware requires some ROS 2 packages in addition to the core components. @@ -127,6 +135,14 @@ sudo apt-get -y install git ```bash vcs import src < autoware.repos + ``` + + > ⚠️ If you are using nightly repositories, you can also update them. + > ```bash + > vcs import src < autoware-nightly.repos + > ``` + + ```bash vcs pull src ``` @@ -148,6 +164,12 @@ sudo apt-get -y install git vcs import src < autoware.repos ``` + > ⚠️ If you are using nightly repositories, import them as well. + > ```bash + > vcs import src < autoware-nightly.repos + > ``` + + 3. Install dependent ROS packages. ```bash From 498adc6201e358fc8412501c194d6ed90a27a958 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 19 Nov 2024 12:45:14 +0000 Subject: [PATCH 2/2] style(pre-commit): autofix --- docs/installation/autoware/docker-installation.md | 4 ++-- docs/installation/autoware/source-installation.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 1dfd58cf34..16a5aa0546 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -122,10 +122,10 @@ Inside the container, you can run the Autoware tutorials by following these link > cd autoware > git pull > vcs import src < autoware.repos -> +> > # If you are using nightly repositories, also run the following command: > vcs import src < autoware-nightly.repos -> +> > vcs pull src > # Make sure all ros-$ROS_DISTRO-* packages are upgraded to their latest version > sudo apt update && sudo apt upgrade diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index 3c216fccbe..a83bba63d9 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -82,7 +82,7 @@ sudo apt-get -y install git ``` If you are an active developer, you may also want to pull the nightly repositories, which contain the latest updates: - + ```bash vcs import src < autoware-nightly.repos ``` @@ -138,6 +138,7 @@ sudo apt-get -y install git ``` > ⚠️ If you are using nightly repositories, you can also update them. + > > ```bash > vcs import src < autoware-nightly.repos > ``` @@ -165,11 +166,11 @@ sudo apt-get -y install git ``` > ⚠️ If you are using nightly repositories, import them as well. + > > ```bash > vcs import src < autoware-nightly.repos > ``` - 3. Install dependent ROS packages. ```bash