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.Write the new version in
package.json
. This file is used by PlatformIO 3 to find the current Pumbaa release.Run the test suites and generate the documentation and other files.
make -s -j8 test-all-boards make -s -j8 release-test
Commit the generated files.
Generate files for Arduino and PlatformIO releases. The generated archives and Arduino manifests are copied to the release repository.
make -s release
Add, commit and push the Pumbaa Arduino releases in the release repository.
(cd ../pumbaa-releases && \ git add arduino/*/*.zip platformio/*.zip && \ git commit && \ git push origin master)
Start a http server used to download package manifests in the Arduino IDE.
(cd make/arduino && python -m SimpleHTTPServer)
Start the Arduino IDE and add these URL:s in Preferences.
http://localhost:8000/esp32/package_pumbaa_esp32_index.json http://localhost:8000/sam/package_pumbaa_sam_index.json
Install all four packages and run the blink example for each one of them.
Commit the manifests, tag the commit with
<major>.<minor>.<revision>
and push.
git commit git tag <major>.<minor>.<revision> git push origin master
- Add, commit and push the Pumbaa Arduino package manifests in the release repository.
(cd ../pumbaa-releases && \ git add arduino/*/*.json && \ git commit && \ git push origin master)
- Done.