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: add apt update/upgrade to workspace install/update instructions #615

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mojomex
Copy link

@mojomex mojomex commented Sep 19, 2024

Description

Added missing instructions to the following guides:

  • Docker update
  • Source install
  • Source update

Specifically, sudo apt update && sudo apt upgrade were missing: rosdep update and rosdep install will not upgrade previously installed ros-$ROS_DISTRO-* packages (even when Autoware is expected to be built with newer versions), which often results in unexpected Autoware build failures.
From my experience in the last two weeks, following the instructions perfectly on a clean Autoware repo succeeded one out of five times mainly due to this issue.

I also added comments that for moved/removed dependencies in the repos files, vcstool will not sync correctly and result in duplicate or wrongly remaining packages, in which case the src directory has to be deleted and re-pulled.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@mojomex mojomex self-assigned this Sep 19, 2024
@mojomex mojomex requested a review from xmfcx September 19, 2024 07:57
@mojomex mojomex added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Sep 19, 2024
@xmfcx
Copy link
Contributor

xmfcx commented Sep 19, 2024

This workflow works on pull_request_target: so it can't be tested like this :(

I will just go ahead and merge the other PR.

Copy link
Contributor

@xmfcx xmfcx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mojomex for improving the documentation!

Fixed the deploy-docs workflow and added 2 comments to the PR.

@mojomex
Copy link
Author

mojomex commented Sep 21, 2024

@xmfcx Thanks for the suggestions, I've addressed them in 6ff3cf5 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants