3.0.0 release process

[d-a-v]

Reference

• Open a new issue to track activities, which will be closed after the release is done.

• Assemble release notes

• Make a PR with below, wait for CI, and merge

  • updated release on platform.txt
  • updated cores/esp8266/TZ.h
  • package.json

• Wait for other maintainers to check on release notes (can be fixed afterwards)

• Tag the latest commit on the master branch, push to esp8266/arduino
  add: git tag -a -m "Release 3.0.0" 3.0.0; git push origin 3.0.0
  remove: git tag -d X.Y.Z; git push --delete origin X.Y.Z

• <= Wait for CI build for the tag to pass, see Actions menu

• Check that the new (draft) release has been created (no editing at this point!), see https://github.com/esp8266/Arduino/releases

• Check that the boards manager package .zip file has been successfully uploaded as a release artifact.

• Check that the package index downloaded from https://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one).

• Navigate to release list in Github here https://github.com/esp8266/Arduino/releases, press "Edit" button to edit release description, paste release notes, and publish it.

• In the issue tracker, remove "staged-for-release" label for all issues which have it, and close them. Close the milestone associated with the released version.

• Check that https://arduino-esp8266.readthedocs.io/en/latest/ has a new doc build for the new tag, and that "stable" points to that build. If a new build did not trigger, log into readthedoc's home here https://readthedocs.org/ (account must have been added to project as maintainer) and trigger it manually.

• Create a Pull-Request (which closes this issue) back to dev (3.0.1) #8039, which:

  • updates the version in platform.txt and package.json file (this should correspond to the version of the next milestone, plus -dev suffix, E.g. 3.1.0-dev)
  • changes version number in the readthedocs link to the version which was just released, and verify that all links work in main README.md, "Latest release" section.