-
Notifications
You must be signed in to change notification settings - Fork 594
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update release issue template (#4180)
* Update release issue template * Fossa and config.yml * adjust release notes
- Loading branch information
Showing
3 changed files
with
79 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
Release Akka HTTP $VERSION$ | ||
|
||
<!-- | ||
Release Train Issue Template for Akka HTTP | ||
(Liberally copied and adopted from Scala itself https://github.com/scala/scala-dev/blob/b11cd2e4a4431de7867db6b39362bea8fa6650e7/notes/releases/template.md) | ||
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=??? | ||
Key links: | ||
- akka/akka-http milestone: https://github.com/akka/akka-http/milestone/? | ||
--> | ||
|
||
### Cutting the release | ||
|
||
- [ ] 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. | ||
- [ ] For minor or major versions, add a release notes entry in `docs/src/main/paradox/release-notes/`. | ||
- [ ] Create a new milestone for the [next version](https://github.com/akka/akka-http/milestones) | ||
- [ ] Close the [$VERSION$ milestone](https://github.com/akka/akka-http/milestones?direction=asc&sort=due_date) | ||
- [ ] Make sure all important PRs have been merged | ||
- [ ] Update the revision in Fossa in the Akka Group for the Akka umbrella version, e.g. `22.10`. Note that the revisions for the release is udpated by Akka Group > Projects > Edit. For recent dependency updates the Fossa validation can be triggered from the GitHub actions "Dependency License Scanning". | ||
- [ ] Wait until [main build finished](https://github.com/akka/akka-http/actions) after merging the latest PR | ||
- [ ] Update the [draft release](https://github.com/akka/akka-http/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-http/actions) for the new tag and publish artifacts to Maven central via Sonatype) | ||
- [ ] Run a test against the staging repository to make sure the release went well, for example by using https://github.com/akka/akka-http-quickstart-scala.g8 and adding the sonatype staging repo with `resolvers += "Staging Repo" at "https://oss.sonatype.org/content/repositories/staging"` | ||
- [ ] Release the staging repository to Maven Central. | ||
|
||
### Check availability | ||
|
||
- [ ] Check [API](https://doc.akka.io/api/akka-http/$VERSION$/) documentation | ||
- [ ] Check [reference](https://doc.akka.io/docs/akka-http/$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/typesafe/akka/akka-http-core_2.13/$VERSION$/ | ||
|
||
### When everything is on maven central | ||
- [ ] Log into `gustav.akka.io` as `akkarepo` | ||
- [ ] If this updates the `current` version, run `./update-akka-http-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-http/current docs/akka-http/$VERSION$ | ||
git add api/akka-http/current api/akka-http/$VERSION$ | ||
git add japi/akka-http/current japi/akka-http/$VERSION$ | ||
git commit -m "Akka HTTP $VERSION$" | ||
``` | ||
- [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io) | ||
``` | ||
cd ~/www | ||
git push origin master | ||
``` | ||
- [ ] Update version in _config.yml in https://github.com/akka/akka.io | ||
|
||
### Announcements | ||
|
||
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](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 (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 | ||
|
||
- [ ] Add the released version to `project/MiMa.scala` to the `mimaPreviousArtifacts` key *of all current compatible branches*. | ||
- [ ] 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) | ||
- Close this issue |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.