Skip to content

Commit b657090

Browse files
authored
package: add version to board package name (#5046)
In tools menu, boards belonging to each platform are grouped together. The title of the groups is the board package name. When switching between versions, mentioning the version number in package name helps identify the installed version. Rename board group from "ESP8266 Modules" to "ESP8266 Boards", to be more similar to other platforms, and to reflect the fact that most entries included are boards, not modules. As an extra change, when building the boards manager package, set version number in platform.txt based on git tag name. This saves one step when creating the release — don't need to update platform.txt twice. Closes #5007.
1 parent 5c7dbf4 commit b657090

File tree

3 files changed

+17
-19
lines changed

3 files changed

+17
-19
lines changed

Diff for: package/README.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -57,37 +57,33 @@ Here is an overview of the release process. See the section below for detailed i
5757

5858
* When done, put release notes into a private Gist and send the link to other maintainers for review.
5959

60-
2. Create a commit on the master branch, making the following changes:
61-
62-
* Set version in platform.txt to the version about to be released. E.g. change from `2.4.0-dev` to `2.4.0`
63-
64-
* In main README.md, in "Latest release" section, change version number in the readthedocs link to the version which is about to be created.
65-
66-
* Commit message should be `Release X.Y.Z`
67-
68-
3. Tag the commit created in step 2. In this project, tags have form `X.Y.Z`, e.g. `2.4.0`, or `X.Y.Z-rcN` for release 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):
60+
2. 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-rcN` for release 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):
6961

7062
```
7163
git tag -a -m "Release 2.4.0" 2.4.0
7264
```
7365

74-
4. Push the commit created in step 2 and the tag created in step 3 to esp8266/Arduino Github repository:
66+
3. Push the tag created in step 2 to esp8266/Arduino Github repository:
7567

7668
```
77-
git push origin --follow-tags master
69+
git push origin 2.4.0
7870
```
7971

80-
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.
72+
4. 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.
8173

82-
6. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266_index.json contains an entry for the new version (it may not be the first one).
74+
5. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266_index.json contains an entry for the new version (it may not be the first one).
8375

84-
7. Navigate to release list in Github, press "Edit" button to edit release description, paste release notes. Remove "draft" status of the release and publish it.
76+
6. Navigate to release list in Github, press "Edit" button to edit release description, paste release notes. Remove "draft" status of the release and publish it.
8577

86-
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.
78+
7. 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.
8779

88-
9. Create a commit to the master branch, updating:
80+
8. Create a commit to the master branch, updating:
8981

9082
* 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`.
9183

92-
* In main README.md, in "Contributing" section, update the "easy issues" link to point to the next milestone.
84+
* In main README.md:
85+
86+
- in "Contributing" section, update the "easy issues" link to point to the next milestone.
87+
88+
- in "Latest release" section, change version number in the readthedocs link to the version which was just released.
9389

Diff for: package/build_boards_manager_package.sh

+3-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,9 @@ $SED 's/runtime.tools.esptool.path={runtime.platform.path}\/tools\/esptool//g' |
8282
$SED 's/tools.esptool.path={runtime.platform.path}\/tools\/esptool/tools.esptool.path=\{runtime.tools.esptool.path\}/g' | \
8383
$SED 's/tools.mkspiffs.path={runtime.platform.path}\/tools\/mkspiffs/tools.mkspiffs.path=\{runtime.tools.mkspiffs.path\}/g' |\
8484
$SED 's/recipe.hooks.core.prebuild.1.pattern.*//g' |\
85-
$SED 's/recipe.hooks.core.prebuild.2.pattern.*//g' \
85+
$SED 's/recipe.hooks.core.prebuild.2.pattern.*//g' |\
86+
$SED "s/version=.*/version=$ver/g" |\
87+
$SED -E "s/name=([a-zA-Z0-9\ -]+).*/name=\1($ver)/g"\
8688
> $outdir/platform.txt
8789

8890
# Put core version and short hash of git version into core_version.h

Diff for: platform.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# For more info:
66
# https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5---3rd-party-Hardware-specification
77

8-
name=ESP8266 Modules
8+
name=ESP8266 Boards (2.5.0-dev)
99
version=2.5.0-dev
1010

1111
runtime.tools.xtensa-lx106-elf-gcc.path={runtime.platform.path}/tools/xtensa-lx106-elf

0 commit comments

Comments
 (0)