Release 10.5.1

[johanandren]

Release Akka HTTP 10.5.1

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
• Close the 10.5.1 milestone
• Make sure all important PRs have been merged
• For recent dependency updates or changes on a minor release branch the Fossa validation can be triggered from the GitHub actions "Dependency License Scanning" (Manually choosing the release branch)
• 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 after merging the latest PR
• Update the draft release with the next tag version v10.5.1, 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 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 documentation
• Check reference 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/10.5.1/

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 10.5.1
  • 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/10.5.1
    git add api/akka-http/current api/akka-http/10.5.1
    git add japi/akka-http/current japi/akka-http/10.5.1
    git commit -m "Akka HTTP 10.5.1"
    

  • push changes to the remote git repository

    cd ~/www
    git push origin master
    

• If this updated 'current' docs - trigger a re-index of the docs for search through Run workflow for the scraper

• 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
• Tweet using the @akkateam account (or ask someone to) about the new release
• Announce on Gitter 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 in private project
• Update akka-dependencies bom
• Update Akka Guide samples
• Close this issue