Skip to content

Commit 3348ddf

Browse files
authored
Update README.md (#5519)
clarify some points, add links, add doc/conf.py
1 parent 574a121 commit 3348ddf

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

package/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ The following points assume work in a direct clone of the repository, and not in
103103
git push origin 2.5.0
104104
```
105105

106-
5. Wait for Travis CI build for the tag to pass. Check that the new (draft) release has been created. Check that the boards manager package .zip file has been successfully uploaded as a release artifact.
106+
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.
107107

108108
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).
109109

110-
7. Navigate to release list in Github, press "Edit" button to edit release description, paste release notes, and publish it.
110+
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.
111111

112112
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.
113113

114-
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 and trigger it manually.
114+
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.
115115

116116

117117
10. Create a commit to the master branch, updating:
@@ -121,3 +121,6 @@ The following points assume work in a direct clone of the repository, and not in
121121
* In main README.md:
122122

123123
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
124+
* In doc/conf.py
125+
126+
- update version and release to the *next* milestone

0 commit comments

Comments
 (0)