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

Implement GitHub workflow to automate releases

Browse Source 
The workflow creates a GitHub Release Draft as follows:

 - Title with a version number parsed from the git ref that triggerd the workflow
 - Body parsed from the changelog
 - Compiled .elf and .hex files for board versions 3.5 and 3.6
 - Python package (as .tar.gz file)

The workflow was tested by adding the trigger
`on.push.branches: [autorelease/v0.5.2]` and then pushing onto
that branch.
This commit is contained in:
Samuel Sadok
2020-10-02 16:30:43 +02:00
parent 1dbe456cfb
commit 8660de2a94
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
@@ -274,9 +274,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: