Update release issue template (#1706)

RELEASING.md

@@ -5,7 +5,7 @@
 Akka gRPC is released when there is a need for it.
 
 If you want to test an improvement that is not yet released, you can use a
-snapshot version: we release all commits to master to the snapshot repository
+snapshot version: we release all commits to main to the snapshot repository
 on [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/lightbend/akka/grpc).
 
 ## How to release
@@ -16,12 +16,6 @@ Create a new issue from the [Release Train Issue Template](docs/release-train-is
 $ sh ./scripts/create-release-issue.sh 0.x.y
 ```
 
-or:
-
-```
-$ sh ./scripts/create-release-issue.sh 0.x.y -patch
-```
-
 ## Gradle plugin release details
 
 The Gradle plugin goes directly to the Gradle Plugin Portal. Publishing keys are stored as Github Action secrets and

docs/release-train-issue-template.md

@@ -4,61 +4,59 @@ Release Akka gRPC $VERSION$
 
 (Liberally copied and adopted from Scala itself https://github.com/scala/scala-dev/blob/b11cd2e4a4431de7867db6b39362bea8fa6650e7/notes/releases/template.md)
 
-For every release, make a copy of this file named after the release, and expand the variables.
-Ideally replacing variables could become a script you can run on your local machine.
+For every release, use the `scripts/create-release-issue.sh` to make a copy of this file named after the release, and expand the variables.
 
 Variables to be expanded in this template:
 - $VERSION$=??? 
 
 -->
 
-### Before the release
-
-- [ ] Make sure all important / big PRs have been merged by now
-- [ ] Create a news item draft PR on [akka.github.com](https://github.com/akka/akka.github.com), using the [draft release](https://github.com/akka/akka-grpc/releases)
-
 ### Cutting the release
 
-- [ ] Make sure the [Github Actions build](https://github.com/akka/akka-grpc/actions?query=branch%3Amain) for the commit you would like to release has completed.
-- [ ] Tag the release `git tag -a -m 'Release v$VERSION$' v$VERSION$` and push the tag `git push --tags`
-- [ ] Check that the GitHub Actions release build has executed successfully (it should publish artifacts to Sonatype and documentation to Gustav)
+- [ ] Check that open PRs and issues assigned to the milestone are reasonable
+- [ ] For minor or major versions, update the Change date in the LICENSE file and update the `licenses` url in the build.
+- [ ] Create a new milestone for the [next version](https://github.com/akka/akka-grpc/milestones)
+- [ ] Close the [$VERSION$ milestone](https://github.com/akka/akka-grpc/milestones?direction=asc&sort=due_date)
+- [ ] Make sure all important PRs have been merged
+- [ ] Wait until [main build finished](https://github.com/akka/akka-grpc/actions) after merging the latest PR
+- [ ] Update the [draft release](https://github.com/akka/akka-grpc/releases) with the next tag version `v$VERSION$`, title and release description. Use the `Publish release` button, which will create the tag.
+- [ ] Check that GitHub Actions release build has executed successfully (GitHub Actions will start a [CI build](https://github.com/akka/akka-grpc/actions) for the new tag and publish artifacts to Maven central via Sonatype)
 
 ### Check availability
 
-- [ ] Check [reference](https://doc.akka.io/docs/akka-grpc/$VERSION$/) documentation
+- [ ] Check [API](https://doc.akka.io/api/akka-grpc/$VERSION$/) documentation
+- [ ] Check [reference](https://doc.akka.io/docs/akka-grpc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
 - [ ] Check the release on [Maven central](https://repo1.maven.org/maven2/com/lightbend/akka/grpc/akka-grpc-scalapb-protoc-plugin_2.12/$VERSION$/)
 
 ### When everything is on maven central
-  - [ ] `ssh akkarepo@gustav.akka.io`
-    - [ ] update the `current` links on `repo.akka.io` to point to the latest version with
-         ```
-         ln -nsf $VERSION$ www/docs/akka-grpc/current
-         ln -nsf $VERSION$ www/api/akka-grpc/current
-         ```
-    - [ ] check changes and commit the new version to the local git repository
+  - [ ] Log into `gustav.akka.io` as `akkarepo` 
+    - [ ] If this updates the `current` version, run `./update-akka-grpc-current-version.sh $VERSION$`
+    - [ ] otherwise check changes and commit the new version to the local git repository
          ```
          cd ~/www
+         git status
          git add docs/akka-grpc/current docs/akka-grpc/$VERSION$
          git add api/akka-grpc/current api/akka-grpc/$VERSION$
          git commit -m "Akka gRPC $VERSION$"
          ```
-    - [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
-         ```
-         cd ~/www
-         git push origin master
-         ```
 
 ### Announcements
 
-- [ ] Merge draft news item for [akka.io](https://github.com/akka/akka.github.com)
-- [ ] Edit the [release draft](https://github.com/akka/akka-grpc/releases) with the next tag version `v$VERSION$`, title and release description.
+For important patch releases, and only if critical issues have been fixed:
+
 - [ ] Send a release notification to [Lightbend discuss](https://discuss.akka.io)
-- [ ] Tweet using the akkateam account (or ask someone to) about the new release
+- [ ] Tweet using the [@akkateam](https://twitter.com/akkateam/) account (or ask someone to) about the new release
 - [ ] Announce on [Gitter akka/akka](https://gitter.im/akka/akka)
-- [ ] Announce internally
-- [ ] Update to the released version [here](https://github.com/lightbend/lightbend-technology-intro-doc/blob/master/docs/modules/getting-help/examples/project/akka-grpc.sbt)
-- [ ] For minor releases, record it [here](https://github.com/lightbend/together-portal/blob/master/app/models/Product.scala#L48)
+- [ ] Announce internally (with links to Tweet, discuss)
+
+For minor or major releases:
+
+- [ ] Include noteworthy features and improvements in Akka umbrella release announcement at akka.io. Coordinate with PM and marketing.
 
 ### Afterwards
 
+- [ ] Update version for [Lightbend Supported Modules](https://developer.lightbend.com/docs/lightbend-platform/introduction/getting-help/build-dependencies.html) in [private project](https://github.com/lightbend/lightbend-technology-intro-doc/blob/master/docs/modules/getting-help/examples/build.sbt)
+- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies)
+- [ ] Update [Akka Guide samples](https://github.com/akka/akka-platform-guide)
+- [ ] Update [Akka Projection gRPC samples](https://github.com/akka/akka-projection/tree/main/samples/grpc)
 - Close this issue

scripts/create-release-issue.sh

@@ -5,6 +5,6 @@ if [ -z $VERSION ]
 then
   echo specify the version name to be released, eg. 1.0.0
 else
-  sed -e 's/\$VERSION\$/'$VERSION'/g' docs/release-train-issue-template$2.md > /tmp/release-$VERSION.md
-  echo Created $(hub issue create -F /tmp/release-$VERSION.md --browse)
+  sed -e 's/\$VERSION\$/'$VERSION'/g' docs/release-train-issue-template.md > /tmp/release-$VERSION.tmp
+  echo Created $(gh issue create --title "Release $VERSION" --body-file /tmp/release-$VERSION.md --milestone $VERSION --web)
 fi