Skip to content

Commit 013d01d

Browse files
authored
update release doc (esp8266#5675)
1 parent 8aadd31 commit 013d01d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

package/README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -105,32 +105,33 @@ Here is an overview of the release process. See the section below for detailed i
105105
106106
The following points assume work in a direct clone of the repository, and not in a personal fork.
107107
108-
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.
108+
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.
109109
110110
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):
111111
112112
```
113113
git tag -a -m "Release 2.5.0" 2.5.0
114114
```
115115
116-
4. Push the tag created in step 2 to esp8266/Arduino Github repository:
116+
4. Push the tag created in step 3 to esp8266/Arduino Github repository:
117117
118118
```
119119
git push origin 2.5.0
120120
```
121121
122-
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.
122+
5. Wait for Travis CI build for the tag to pass, see https://travis-ci.org/esp8266/Arduino/builds.
123123
124-
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).
124+
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.
125125
126-
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.
126+
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).
127127
128-
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.
128+
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.
129129
130-
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.
130+
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.
131131
132+
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.
132133
133-
10. Create a commit to the master branch, updating:
134+
11. Create a commit to the master branch, updating:
134135
135136
* 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`.
136137

0 commit comments

Comments
 (0)