mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-08-23 11:03:46 +08:00
Justin Newberry
ad3ae98a19
* casync in jenkins
* rename some stuff, add a readme
* slightly better names
* clean
* more cleanup
* cleaner
* release3 staging too
* always rm the signed version
* cleanups
* in build dir
* better name
* simpler
* more
* divider
* built
* build
* and contains
* add channel description
* and git branches
* and build required
* move this up
* these are terms
* updates
* 3/3x
* bullets
* wording
* version metadata
* git type
* more channel -> release
* more build
* just release
* more channel to release
* also fix jenkins
* use build_metadata
* fix normailzed
* also normalized
* and here
* use build_metadata
* dont commit that
* don't touch the git stuff
* branch
* don't need that
* or that
* improved names
* build_metadata
* use this instead
* fix
* build
* test nightly build again
* fix
* fixes
* Revert "test nightly build again"
This reverts commit be5e7aa7089bfc0947c9b2b484d0277c109ee089.
old-commit-hash: c3bbc58a85
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
# openpilot releases
|
|
|
|
|
|
## terms
|
|
|
|
- `channel` - a named version of openpilot (git branch, casync caidx) which receives updates
|
|
- `build` - a release which is already built for the comma 3/3x and contains only required files for running openpilot and identifying the release
|
|
|
|
- `build_style` - type of build, either `debug` or `release`
|
|
- `debug` - build with `ALLOW_DEBUG=true`, can test experimental features like longitudinal on alpha cars
|
|
- `release` - build with `ALLOW_DEBUG=false`, experimental features disabled
|
|
|
|
|
|
## openpilot channels
|
|
|
|
| channel | build_style | description |
|
|
| ----------- | ----------- | ---------- |
|
|
| release | `release` | stable release of openpilot |
|
|
| staging | `release` | release candidate of openpilot for final verification |
|
|
| nightly | `release` | generated nightly from last commit passing CI tests |
|
|
| master | `debug` | current master commit with experimental features enabled |
|
|
| git branches | `debug` | installed manually, experimental features enabled, build required |
|
|
|
|
|
|
## creating casync build
|
|
|
|
`create_casync_build.sh` - creates a 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 \
|
|
OPENPILOT_CHANNEL=nightly \
|
|
release/create_casync_build.sh
|
|
```
|
|
|
|
`upload_casync_release.sh` - helper for uploading a casync build to `openpilot-releases`
|
|
|
|
|
|
## release builds
|
|
|
|
to create a release build, set `RELEASE=1` environment variable when running the build script
|