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

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

Merged
merged 2 commits into from
Nov 20, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(installation): add information about nightly.repos
Signed-off-by: M. Fatih Cırıt <[email protected]>
xmfcx committed Nov 19, 2024
commit 1e00be8d4a435ffc5ee8aca9b303dd0660f17d4a
14 changes: 14 additions & 0 deletions docs/installation/autoware/docker-installation.md
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions docs/installation/autoware/source-installation.md
Original file line number Diff line number Diff line change
@@ -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