Mirrors_Framework/ODrive
1
0
Fork 0
mirror of https://github.com/odriverobotics/ODrive.git synced 2026-09-23 00:59:54 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #499 from madcowswe/autorelease/v0.5.2

Browse Source 
Implement GitHub workflow to automate releases
This commit is contained in:
samuelsadok
2020-12-08 16:23:43 +01:00
committed by GitHub
parent 8eed949d33 8660de2a94
commit e52f0f8181
4 changed files with 178 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer-guide.md
+11 -3
View File
@@ -276,9 +276,17 @@ We use GitHub Releases to provide firmware releases.
1. Cut off the changelog to reflect the new release
2. Merge the release candidate into master.
3. Push a (lightweight) tag to the master branch. Follow the existing naming convention.
4. Push the python tools to PyPI.
5. Edit the release on GitHub to add a title and description (copy&paste from changelog).
3. Push a (lightweight) tag to the master branch.
- Releases should be named like `fw-v0.1.23`
- Prereleases should be named like `fw-v0.1.23-rc` or `fw-v0.1.23-rc4`
4. Go to the GitHub Releases page and review the draft that will have been created by a GitHub Action by now. If you're satisfied, go ahead and publish it by pressing Edit > **Publish Release**.
5. Download `python-odrive-*.tar.gz` from the Releases page. The following step assumes that the version is `0.1.2`
6. Run
```
mv {python-,}odrive-0.1.23.tar.gz
pip3 install twine
python3 -m twine upload odrive-0.1.23.tar.gz # Only works once per version!
```
## Other code maintenance notes
The cortex M4F processor has hardware single precision float unit. However double precision operations are not accelerated, and hence should be avoided. The following regex is helpful for cleaning out double constants: