workflow docs (#30703)
* start workflow docs
* update
* update
* linter
* update
* update
old-commit-hash: 7931561416
chrysler-long2
parent
214b38bc69
commit
dcf5c24ee2
2 changed files with 42 additions and 8 deletions
@ -0,0 +1,42 @@ |
|||||||
|
# openpilot development workflow |
||||||
|
|
||||||
|
Aside from the ML models, most tools used for openpilot development are in this repo. |
||||||
|
|
||||||
|
Most development happens on normal Ubuntu workstations, and not in cars or directly on comma devices. |
||||||
|
|
||||||
|
## Quick start |
||||||
|
|
||||||
|
```bash |
||||||
|
# get the latest stuff |
||||||
|
git pull |
||||||
|
git submodule update --init --recursive |
||||||
|
|
||||||
|
# update dependencies |
||||||
|
tools/ubuntu_setup.sh |
||||||
|
|
||||||
|
# build everything |
||||||
|
scons -j$(nproc) |
||||||
|
|
||||||
|
# build just the ui with either of these |
||||||
|
scons -j8 selfdrive/ui/ |
||||||
|
cd selfdrive/ui/ && scons -u -j8 |
||||||
|
|
||||||
|
# test everything |
||||||
|
pytest . |
||||||
|
|
||||||
|
# test just logging services |
||||||
|
cd system/loggerd && pytest . |
||||||
|
|
||||||
|
# run the linter |
||||||
|
pre-commit run --all |
||||||
|
``` |
||||||
|
|
||||||
|
## Testing |
||||||
|
|
||||||
|
### Automated Testing |
||||||
|
|
||||||
|
All PRs and commits are automatically checked by GitHub Actions. Check out `.github/workflows/` for what GitHub Actions runs. Any new tests should be added to GitHub Actions. |
||||||
|
|
||||||
|
### Code Style and Linting |
||||||
|
|
||||||
|
Code is automatically checked for style by GitHub Actions as part of the automated tests. You can also run these tests yourself by running `pre-commit run --all`. |
Loading…
Reference in new issue