From 786f21a195db61cf4be049c73665d47a4307af41 Mon Sep 17 00:00:00 2001 From: tallison Date: Fri, 15 Nov 2024 10:32:55 -0500 Subject: [PATCH 1/3] #1412 - update RELEASING.md notes --- RELEASING.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 5fb195f43..59dc27f24 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -108,8 +108,10 @@ export GPG_TTY=$(tty) - Next, checkout the svn dist dev space from https://dist.apache.org/repos/dist/dev/incubator/stormcrawler - Create a new folder `stormcrawler-x.y.z-RC1`. - Add the `apache-stormcrawler-VERSION-incubating-source-release*` files from `stormcrawler/target/` to this folder. + - `echo " apache-stormcrawler-3.2.0-incubating-source-release.tar.gz" >> apache-stormcrawler-3.2.0-incubating-source-release.tar.gz.sha512` + - `echo " apache-stormcrawler-3.2.0-incubating-source-release.zip" >> apache-stormcrawler-3.2.0-incubating-source-release.zip.sha512` - Ensure to add the file name to the `sha512` signature of the `apache-stormcrawler-VERSION-incubating-source-release*.zip.sha512` file as this is not automatically done via Maven. -- Commit the change set to the dist area. Check that the files are present in https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z-RC1 +- Commit the change set to the dist area (commit message "adding X.Y.Z-RC1"). Check that the files are present in https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z-RC1 #### Check the Release Artifacts @@ -139,18 +141,25 @@ gpg --homedir . --import KEYS echo " verify signature " -gpg --homedir . --output apache-stormcrawler-x.y.z-RC1-incubating-source-release.tar.gz --decrypt apache-stormcrawler-x.y.z-RC1-incubating-source-release.tar.gz.asc +gpg --homedir . --output apache-stormcrawler-x.y.z-incubating-source-release.tar.gz --decrypt apache-stormcrawler-x.y.z-incubating-source-release.tar.gz.asc ``` -- Check presence and appropriateness of `LICENSE`, `NOTICE`, `DISCLAIMER` and `README` files. +- Check presence and appropriateness of `LICENSE`, `NOTICE`, `DISCLAIMER` and `README.md` files. ### Prepare the Website - Create a separate branch for the release. +- Global replace the old version with the new version. - Prepare a preview via the staging environment of the website. - Ensure the website is updated on https://stormcrawler.staged.apache.org - Note: Instruction on how to do so can be found on https://github.com/apache/incubator-stormcrawler-site +### Create a draft release on Github +- Create a new Draft Release -- on https://github.com/apache/incubator-stormcrawler/releases, click `Draft a new release` and select the `stormcrawler-X.Y.Z-rc1` tag. +- Click the `Generate Release Notes`. Copy and paste the Disclaimer and Release Summary from the previous release and update the Release Summary as appropriate. +- Click the `Set as pre-release` button. +- Click `Publish release`. The release should have `*-rc1` in its title, e.g.: `https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-3.2.0-rc1` + #### Create a VOTE Thread The VOTE process is two-fold: @@ -182,7 +191,7 @@ https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z Tag: -https://github.com/apache/stormcrawler/releases/tag/stormcrawler-x.y.z +https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-x.y.z-rc1 Commit Hash: From 537848d7a4867d01aa98a310c2accb814d932891 Mon Sep 17 00:00:00 2001 From: tallison Date: Fri, 15 Nov 2024 10:43:18 -0500 Subject: [PATCH 2/3] #1412 - update RELEASING.md notes --- RELEASING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 59dc27f24..c8e2f3779 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -85,11 +85,11 @@ export GPG_TTY=$(tty) ## Release Steps - Checkout the Apache StormCrawler main branch: `git clone git@github.com:apache/incubator-stormcrawler.git` -- (Optional) Execute a complete test: `mvn test` +- Execute a complete test: `mvn test` - Check the current results of the last GitHub action runs. - Do a trial build: `mvn package -Papache-release,apache-gpg` - Switch to a new branch with a format like **rel-stormcrawler-x.y.z-RC?** -- Prepare the release: `mvn release:prepare -Papache-release,apache-gpg` Answer the questions appropriately. The tag name format should be *stormcrawler-x.y.z*. +- Prepare the release: `mvn release:prepare -Papache-release,apache-gpg` Answer the questions appropriately. The tag name format should be *stormcrawler-x.y.z*. **DO NOT INCLUDE `-rcX` in the tag** This command creates and pushes two new commits to the repository to reflect the version changes. It also tags the release and pushes the branch. - Check the result of the GitHub action runs. @@ -156,7 +156,7 @@ gpg --homedir . --output apache-stormcrawler-x.y.z-incubating-source-release.ta ### Create a draft release on Github - Create a new Draft Release -- on https://github.com/apache/incubator-stormcrawler/releases, click `Draft a new release` and select the `stormcrawler-X.Y.Z-rc1` tag. -- Click the `Generate Release Notes`. Copy and paste the Disclaimer and Release Summary from the previous release and update the Release Summary as appropriate. +- Click the `Generate Release Notes` (**MAKE SURE TO SELECT THE CORRECT PREVIOUS RELEASE AS THE BASE**). Copy and paste the Disclaimer and Release Summary from the previous release and update the Release Summary as appropriate. - Click the `Set as pre-release` button. - Click `Publish release`. The release should have `*-rc1` in its title, e.g.: `https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-3.2.0-rc1` From eff969ca6b1e7d38a1255ef518d1c9c2934bc5b4 Mon Sep 17 00:00:00 2001 From: tallison Date: Fri, 15 Nov 2024 10:59:29 -0500 Subject: [PATCH 3/3] #1412 - update RELEASING.md notes --- RELEASING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index c8e2f3779..b33575719 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -149,16 +149,16 @@ gpg --homedir . --output apache-stormcrawler-x.y.z-incubating-source-release.ta ### Prepare the Website - Create a separate branch for the release. -- Global replace the old version with the new version. +- Run a global replace of the old version with the new version. - Prepare a preview via the staging environment of the website. - Ensure the website is updated on https://stormcrawler.staged.apache.org - Note: Instruction on how to do so can be found on https://github.com/apache/incubator-stormcrawler-site ### Create a draft release on Github -- Create a new Draft Release -- on https://github.com/apache/incubator-stormcrawler/releases, click `Draft a new release` and select the `stormcrawler-X.Y.Z-rc1` tag. +- Create a new Draft Release -- on https://github.com/apache/incubator-stormcrawler/releases, click `Draft a new release` and select the `stormcrawler-X.Y.Z` tag. - Click the `Generate Release Notes` (**MAKE SURE TO SELECT THE CORRECT PREVIOUS RELEASE AS THE BASE**). Copy and paste the Disclaimer and Release Summary from the previous release and update the Release Summary as appropriate. - Click the `Set as pre-release` button. -- Click `Publish release`. The release should have `*-rc1` in its title, e.g.: `https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-3.2.0-rc1` +- Click `Publish release`. The release should not have `*-rc1` in its title, e.g.: `https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-3.2.0` #### Create a VOTE Thread @@ -191,7 +191,7 @@ https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z Tag: -https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-x.y.z-rc1 +https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-x.y.z Commit Hash: @@ -297,6 +297,10 @@ Remove the old releases from SVN under https://dist.apache.org/repos/dist/releas - Check, that the website is deployed successfully. - Instruction on how to do so can be found on https://github.com/apache/incubator-stormcrawler-site +### Make the release on Github + +- Remove the `draft` status from the release and select this release as the latest. + ### Post-Release Steps - Close the present release ticket