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.

Sign up for GitHub

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(support/troubleshooting): add information about setuptools issue in the troubleshooting section #315

Merged
merged 3 commits into from
Feb 2, 2023
Merged

docs(support/troubleshooting): add information about setuptools issue in the troubleshooting section #315

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcb8ce8
Add information about setuptools issue in the troubleshooting section
lchojnack Feb 2, 2023
05ddd65
style(pre-commit): autofix
pre-commit-ci[bot] Feb 2, 2023
11d11a7
Add language specification to fenced code blocks
lchojnack Feb 2, 2023
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
17 changes: 17 additions & 0 deletions docs/support/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,23 @@ In addition to the causes listed above, there are two common misunderstandings a
2. You didn't update the workspace after changing the branch of `autowarefoundation/autoware`.
Changing the branch of `autowarefoundation/autoware` does not affect the files under `src/`. You have to run the `vcs import` command to update them.

### Error when building python package

During building the following issue can occurs

```bash
pkg_resources.extern.packaging.version.InvalidVersion: Invalid version: '0.23ubuntu1'
```

The error is due to the fact that since version 66.0.0 `setuptools` enforces the python packages to be
[PEP-440](https://peps.python.org/pep-0440/) conformant.

The workaround is to lower the version of `setuptools` to 65 or lower. It can be done using the following command

```bash
pip install -U setuptools==65.7.0
```

## Docker/rocker issues

If any errors occur when running Autoware with Docker or rocker, first confirm that your Docker installation is working correctly by running the following commands:
Expand Down