openpilot is an open source driver assistance system. openpilot performs the functions of Automated Lane Centering and Adaptive Cruise Control for over 200 supported car makes and models.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

42 lines
1.8 KiB

# openpilot releases
## terms
- `channel` - a named version of openpilot (git branch, casync caidx) which receives updates
- `prebuilt` - a release which is already built for the comma 3/3x and contains only required files for running openpilot and identifying the release
- `release` - a `prebuilt` release with `ALLOW_DEBUG=false` (`RELEASE=1` when building panda, ex: `nightly`, `release3`)
1 year ago
## openpilot channels
| channel | type | description |
| ----------- | ----------- | ---------- |
| release3 | `release` | channel for end users |
| staging | `release` | staging channel for release3 |
| nightly | `release` | generated nightly from last commit passing CI tests |
| master | `prebuilt` | current master commit with experimental features enabled |
1 year ago
| git branches | `git` | installed manually, experimental features enabled, build required |
1 year ago
## creating casync build
`create_casync_prebuilt.sh` - creates a `prebuilt` casync openpilot build, ready to upload to `openpilot-releases`
```bash
# run on a tici, within the directory you want to create the build from.
# creates a prebuilt version of openpilot into BUILD_DIR and outputs the caidx
# and other casync files into CASYNC_DIR for uploading to openpilot-releases.
BUILD_DIR=/data/openpilot_build \
CASYNC_DIR=/data/casync \
1 year ago
OPENPILOT_CHANNEL=nightly \
1 year ago
release/create_casync_prebuilt.sh
```
`upload_casync_release.sh` - helper for uploading a casync release to `openpilot-releases`
1 year ago
## release builds
1 year ago
to create a release build, set `RELEASE=1` environment variable when running the build script