Skip to content

Commit 4549e4f

Browse files
authored
Update Release Note Generation and Docs (#7936)
* Update Release Note Generation to work with GitHub Issues * Update Release Note Generation to work with GitHub Issues
1 parent e8447c8 commit 4549e4f

File tree

7 files changed

+121
-431
lines changed

7 files changed

+121
-431
lines changed

README.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ You can subscribe to this list by sending an email to [dev-subscribe@storm.apach
3131

3232
You can also [browse the archives of the storm-dev mailing list](https://mail-archives.apache.org/mod_mbox/storm-dev/).
3333

34-
Storm developers who would want to track the JIRA issues should subscribe to [issues@storm.apache.org](mailto:issues@storm.apache.org).
34+
Storm developers who would want to track issues should subscribe to [issues@storm.apache.org](mailto:issues@storm.apache.org).
3535

3636
You can subscribe to this list by sending an email to [issues-subscribe@storm.apache.org](mailto:issues-subscribe@storm.apache.org). Likewise, you can cancel a subscription by sending an email to [issues-unsubscribe@storm.apache.org](mailto:issues-unsubscribe@storm.apache.org).
3737

3838
You can view the archives of the mailing list [here](https://mail-archives.apache.org/mod_mbox/storm-issues/).
3939

4040
### Issue tracker
41-
In case you want to raise a bug/feature or propose an idea, please use [Apache Jira](https://issues.apache.org/jira/projects/STORM).
41+
In case you want to raise a bug/feature or propose an idea, please use [GitHub Issues](https://github.com/apache/storm/issues).
4242
If you do not have an account, you need to create one.
4343

4444
### Which list should I send/subscribe to?

RELEASING.md

+24-10
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Apache Storm follows the basic idea of [Semantic Versioning](https://semver.org/
5151

5252

5353
If you are setting up a new MINOR version release, create a new branch based on `master` branch, e.g. `2.6.x-branch`. Then on master branch, set the version to a higher MINOR version (with SNAPSHOT), e.g. `mvn versions:set -DnewVersion=2.3.0-SNAPSHOT -P dist,rat,externals,examples`.
54-
In this way, you create a new release line and then you can create PATCH version releases from it, e.g. `2.6.0`.
54+
In this way, you create a new release line and then you can create PATCH version releases from it, e.g. `2.8.1`.
5555

5656
## Setting up a vote
5757

@@ -60,38 +60,50 @@ In this way, you create a new release line and then you can create PATCH version
6060
2. Run `mvn release:prepare -P dist,rat,externals,examples` followed `mvn release:perform -P dist,rat,externals,examples`.
6161
This will create all the artifacts that will eventually be available in maven central. This step may seem simple,
6262
but a lot can go wrong (mainly flaky tests). Note that this will create and push two commits with the commit message
63-
starting with "[maven-release-plugin]" and it will also create and publish a git tag, e.g. `v2.6.0`. Note: the full build can take up to 30 minutes to complete.
63+
starting with "[maven-release-plugin]" and it will also create and publish a git tag, e.g. `v2.8.1`. Note: the full build can take up to 30 minutes to complete.
6464

6565
3. Once you get a successful maven release, a “staging repository” will be created at http://repository.apache.org
6666
in the “open” state, meaning it is still writable. You will need to close it, making it read-only. You can find more
6767
information on this step [here](https://infra.apache.org/publishing-maven-artifacts.html).
6868

69-
4. Checkout to the git tag that was published by Step 1 above, e.g. `git checkout tags/v2.6.0 -b v2.6.0`.
69+
4. Checkout to the git tag that was published by Step 1 above, e.g. `git checkout tags/v2.8.1 -b v2.8.1`.
7070
Then build it with `mvn clean install -DskipTests`. Run `mvn package` for `storm-dist/binary` and `storm-dist/source`
7171
to create the actual distributions.
7272

7373
5. Generate checksums for the *.tar.gz and *.zip distribution files, e.g.
7474
```bash
7575
pushd storm-dist/source/target
76-
sha512sum apache-storm-2.6.0-src.zip > apache-storm-2.6.0-src.zip.sha512
77-
sha512sum apache-storm-2.6.0-src.tar.gz > apache-storm-2.6.0-src.tar.gz.sha512
76+
sha512sum apache-storm-2.8.1-src.zip > apache-storm-2.8.1-src.zip.sha512
77+
sha512sum apache-storm-2.8.1-src.tar.gz > apache-storm-2.8.1-src.tar.gz.sha512
7878
popd
7979

8080
pushd storm-dist/binary/final-package/target
81-
sha512sum apache-storm-2.6.0.zip > apache-storm-2.6.0.zip.sha512
82-
sha512sum apache-storm-2.6.0.tar.gz > apache-storm-2.6.0.tar.gz.sha512
81+
sha512sum apache-storm-2.8.1.zip > apache-storm-2.8.1.zip.sha512
82+
sha512sum apache-storm-2.8.1.tar.gz > apache-storm-2.8.1.tar.gz.sha512
8383
popd
8484
```
8585

8686
6. Create a directory in the dist svn repo for the release candidate: https://dist.apache.org/repos/dist/dev/storm/apache-storm-x.x.x-rcx
8787

8888
7. Run `dev-tools/release_notes.py` for the release version, piping the output to a RELEASE_NOTES.html file. Move that file to the svn release directory, sign it, and generate checksums, e.g.
8989
```bash
90-
python3 dev-tools/release_notes.py 2.6.0 > RELEASE_NOTES.html
90+
export GITHUB_TOKEN=MY_PERSONAL_ACCESS_TOKEN_FOR_GI
91+
python3 dev-tools/release_notes.py <id-of-the-github-milestone> > RELEASE_NOTES.html
9192
gpg --armor --output RELEASE_NOTES.html.asc --detach-sig RELEASE_NOTES.html
9293
sha512sum RELEASE_NOTES.html > RELEASE_NOTES.html.sha512
9394
```
9495

96+
To create a personal access token:
97+
98+
- Go to your GitHub account settings.
99+
- Navigate to **Developer Settings** > **Personal Access Tokens** > **Tokens (classic)**.
100+
- Generate a token with the `public_repo` scope.
101+
102+
To obtain the ID of a GitHub milestone:
103+
- Visit the [milestone overview](https://github.com/apache/storm/milestones).
104+
- Click on the milestone you want to create release notes for.
105+
- Look at the URL in your browser. It will look like this: `https://github.com/apache/storm/milestone/40`, where the last number is the milestone ID.
106+
95107
8. Move the release files from steps 4,5 and 7 to the svn directory from Step 6. Add and commit the files.
96108
This makes them available in the Apache staging repo.
97109

@@ -187,7 +199,9 @@ the site as described in the storm-site README to publish the site.
187199

188200
8. Delete any outdated releases from the storm-site releases directory, and republish the site.
189201

190-
9. Tweet, promote, celebrate. ;) Annoucement email can be sent to announce@apache.org using the following template:
202+
10. Create a release on [GitHub](https://github.com/apache/storm/releases). Generate the release notes with the GitHub tooling.
203+
204+
11. Post, promote, celebrate. ;) Annoucement email can be sent to announce@apache.org using the following template:
191205

192206
```agsl
193207
Subject: [ANNOUNCE] Apache Storm [VERSION] Released
@@ -225,7 +239,7 @@ Regards,
225239
The Apache Storm Team
226240
227241
[1] https://downloads.apache.org/storm/apache-storm-[VERSION]/RELEASE_NOTES.html
228-
[2] https://issues.apache.org/jira/browse/STORM
242+
[2] https://github.com/apache/storm/issues
229243
```
230244

231245
## Cleaning up if the vote fails

dev-tools/jira-github-join.py

-50
This file was deleted.

0 commit comments

Comments
 (0)