From 2e5b48e88f1a9280d483ddff024c066eb247eee5 Mon Sep 17 00:00:00 2001 From: david gauchard Date: Sat, 26 Jan 2019 02:08:58 +0100 Subject: [PATCH 1/3] update release doc --- package/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/package/README.md b/package/README.md index ac9e23de0c..496651b125 100644 --- a/package/README.md +++ b/package/README.md @@ -105,7 +105,7 @@ Here is an overview of the release process. See the section below for detailed i The following points assume work in a direct clone of the repository, and not in a personal fork. -2. Update `version` to the release in platform.txt and commit. E.g. `2.5.0`. Then git push origin to get the commit merged to master. +2. Update `version` to the release in platform.txt and commit. E.g. `2.5.0`. Make a PR, wait for Travis CI, and merge. 3. Tag the latest commit on the master branch. In this project, tags have form `X.Y.Z`, e.g. `2.4.0`, or `X.Y.Z-betaN` for release candiate versions. Notice that there's no `v`at the beginning of the tag. Tags must be annotated, not lightweight tags. To create a tag, use git command (assuming that the master branch is checked out): @@ -113,13 +113,13 @@ The following points assume work in a direct clone of the repository, and not in git tag -a -m "Release 2.5.0" 2.5.0 ``` -4. Push the tag created in step 2 to esp8266/Arduino Github repository: +4. Push the tag created in step 3 to esp8266/Arduino Github repository: ``` git push origin 2.5.0 ``` -5. Wait for Travis CI build for the tag to pass, see https://travis-ci.org/esp8266/Arduino/builds. Check that the new (draft) release has been created, see https://github.com/esp8266/Arduino/releases. Check that the boards manager package .zip file has been successfully uploaded as a release artifact. +5. Wait for Travis CI build for the tag to pass, see https://travis-ci.org/esp8266/Arduino/builds. Check that the new (draft) release has been created (no editing at this point!), see https://github.com/esp8266/Arduino/releases. Wait for CI (travis-ci.org). Check that the boards manager package .zip file has been successfully uploaded as a release artifact. 6. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). @@ -129,7 +129,6 @@ The following points assume work in a direct clone of the repository, and not in 9. 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. - 10. Create a commit to the master branch, updating: * The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`. From bf59e85060735146becb6f2521a4e6b178f1b79d Mon Sep 17 00:00:00 2001 From: Develo Date: Sat, 26 Jan 2019 04:12:46 -0300 Subject: [PATCH 2/3] Update README.md --- package/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/package/README.md b/package/README.md index 496651b125..e247b8d494 100644 --- a/package/README.md +++ b/package/README.md @@ -119,9 +119,11 @@ The following points assume work in a direct clone of the repository, and not in git push origin 2.5.0 ``` -5. Wait for Travis CI build for the tag to pass, see https://travis-ci.org/esp8266/Arduino/builds. Check that the new (draft) release has been created (no editing at this point!), see https://github.com/esp8266/Arduino/releases. Wait for CI (travis-ci.org). Check that the boards manager package .zip file has been successfully uploaded as a release artifact. +5. Wait for Travis CI build for the tag to pass, see https://travis-ci.org/esp8266/Arduino/builds. -6. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). +6. 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. + +7. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). 7. 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. From 858450bc08600ef0611975d76fcbfb498916b27f Mon Sep 17 00:00:00 2001 From: Develo Date: Sat, 26 Jan 2019 04:13:56 -0300 Subject: [PATCH 3/3] Update README.md --- package/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/package/README.md b/package/README.md index e247b8d494..fa3dfa0339 100644 --- a/package/README.md +++ b/package/README.md @@ -125,13 +125,13 @@ The following points assume work in a direct clone of the repository, and not in 7. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). -7. 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. +8. 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. -8. 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. +9. 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. -9. 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. +10. 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. -10. Create a commit to the master branch, updating: +11. Create a commit to the master branch, updating: * The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`.