Releasing¶

Follow these steps to create a new release:

Write the new version in VERSION.txt. The version should hace the format <major>.<minor>.<revision>.

Increment <major> for non-backwards compatible changes.

Increment <minor> for new features.

Increment <revision> for bug fixes.

Update file headers.

for f in $(git ls-files | grep -v "package_simba_*" | xargs) ; do
    sed -i 's/<version>/<new version>/g' $f
done

Run the test suites and generate the documentation.
```
make test-all-boards
make release-test
```
Generate files for Arduino and add the new releases to make/arduino/<family>/package_simba_<family>_index.json. The sha256 sums of the zip-archives are calculated by make arduino and written to simba-arduino/*.sha256.
```
make arduino
```
Make sure that the blink exmaple works in the Arduino IDE.
Commit the changes, and tag the commit with the new version.
Push the new commit and tag.

Copy the Simba Arduino releases to SourceForge.

scp simba-arduino/simba-arduino-avr-*.zip <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/avr
scp simba-arduino/simba-arduino-sam-*.zip <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/sam
scp simba-arduino/simba-arduino-esp-*.zip <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/esp
scp make/arduino/avr/package_simba_avr_index.json <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/avr
scp make/arduino/sam/package_simba_sam_index.json <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/sam
scp make/arduino/esp/package_simba_esp_index.json <user>@frs.sourceforge.net:/home/frs/project/simba-arduino/esp

Done.