Skip to content

bugfix release process (3.0.2) #8241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
14 tasks done
d-a-v opened this issue Jul 26, 2021 · 0 comments · Fixed by #8246
Closed
14 tasks done

bugfix release process (3.0.2) #8241

d-a-v opened this issue Jul 26, 2021 · 0 comments · Fixed by #8246

Comments

@d-a-v
Copy link
Collaborator

d-a-v commented Jul 26, 2021

Reference for details.

  • 1. Make sure that no issues or PRs are assigned to the milestone to be released.

  • 2. Open a new issue to track activities.

  • 3. Assemble release notes.

  • 4. Make a PR with the following, wait for CI, and merge.

  • 5. Wait until the release notes have been checked by other maintainers (can be changed afterwards anyway)

  • 6. Tag the latest commit on the master branch, then push it 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

  • 7. Wait for CI build for the tag to pass (in Actions menu)

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

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

  • 10. 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).

  • 11. Navigate to release list in Github, press "Edit" button to edit release description, paste release notes, and publish it.

  • 12. 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 (the milestone should be empty per point 1 above)

  • 13. 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.

  • 14. Create a commit to the master branch, updating:

    • The version in platform.txt and package.json files. This should correspond to the version of the next milestone, plus -dev suffix. E.g. 3.1.0-dev.
    • In main README.md go to "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant