docs(installation): add information about nightly.repos (#627)

* docs(installation): add information about nightly.repos Signed-off-by: M. Fatih Cırıt <[email protected]> * style(pre-commit): autofix --------- Signed-off-by: M. Fatih Cırıt <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
autowarefoundation · Nov 20, 2024 · 730e4e9 · 730e4e9
1 parent 4d9e059
commit 730e4e9
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git 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
@@ -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,15 @@ 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 +165,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