You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2023/02/22 10:40:44 UTC
[incubator-pekko-http] branch main updated: remove Akka specific release train docs (#79)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-http.git
The following commit(s) were added to refs/heads/main by this push:
new dd41662fd remove Akka specific release train docs (#79)
dd41662fd is described below
commit dd41662fd9118e0951ebf461a180b72be56641c2
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Wed Feb 22 11:40:39 2023 +0100
remove Akka specific release train docs (#79)
---
RELEASING.md | 38 --------------
scripts/commits-for-release-notes.sh | 2 +-
scripts/create-release-issue.sh | 10 ----
scripts/release-train-issue-template.md | 91 ---------------------------------
scripts/release_stats.sh | 6 +--
5 files changed, 4 insertions(+), 143 deletions(-)
diff --git a/RELEASING.md b/RELEASING.md
deleted file mode 100644
index 258bdf5b8..000000000
--- a/RELEASING.md
+++ /dev/null
@@ -1,38 +0,0 @@
-## Releasing
-
-Create a new issue from the [Akka HTTP Release Train Issue Template](scripts/release-train-issue-template.md) by running `scripts/create-release-issue.sh` and follow the steps.
-
-A few more background information about the process can be found below.
-
-### Release Automation with Github Action
-
-Akka HTTP uses Github Actions and the sbt-ci-release plugin to release artifacts automatically. For commits to the `main` branch, it directly publishes artifacts to the Sonatype snapshot repository.
-Tags are published to Maven Central. The process is currently a two-step process:
- * Github Actions uses sbt-ci-release to prepare the release and push it to Sonatype, closing the repository at the end.
- * At that point a staging repository has been created that can be used to validate artifacts.
- * When the release has been validated, the release person needs to manually release the artifacts from staging to Maven Central.
-
-### Releasing only updated docs
-
-It is possible to release a revised documentation to the already existing release.
-
-1. Create a new branch from a release tag. If a revised documentation is for the `v10.2.4` release, then the name of the new branch should be `docs/v10.2.4`:
- ```
- $ git checkout v10.2.4
- $ git checkout -b docs/v10.2.4
- ```
-1. Add and commit `version.sbt` file that pins the version to the one that is being revised. Also set `isSnapshot` to `false` for the stable documentation links. For example:
- ```scala
- ThisBuild / version := "10.2.4"
- ThisBuild / isSnapshot := false
- ```
-1. Make or cherry-pick updates to the docs
-1. Build documentation locally with:
- ```sh
- sbt docs/paradoxBrowse
- ```
-1. Don't forget to commit and push
-1. Upload the docs:
- ```sh
- sbt docs/publishRsync
- ```
diff --git a/scripts/commits-for-release-notes.sh b/scripts/commits-for-release-notes.sh
index d9dbe3111..868998c38 100755
--- a/scripts/commits-for-release-notes.sh
+++ b/scripts/commits-for-release-notes.sh
@@ -6,7 +6,7 @@ ROOT_DIR=$(dirname $(readlink -f $0))/..
LAST_VERSION=$1
-REPLACEMENT="perl -pe s|(.*?)(\(?#(\d+)\)?(\s\(#\d+\))?)?$|\*\1\[#\3\]\(https://github.com/akka/akka-http/pull/\3\)|"
+REPLACEMENT="perl -pe s|(.*?)(\(?#(\d+)\)?(\s\(#\d+\))?)?$|\*\1\[#\3\]\(https://github.com/apache/incubator-pekko-http/pull/\3\)|"
echo "#### pekko-http-core"
echo
diff --git a/scripts/create-release-issue.sh b/scripts/create-release-issue.sh
deleted file mode 100755
index 0559e2496..000000000
--- a/scripts/create-release-issue.sh
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/bin/bash
-
-VERSION=$1
-if [ -z $VERSION ]
-then
- echo specify the version name to be released, eg. 1.0.0
-else
- sed -e 's/\$VERSION\$/'$VERSION'/g' scripts/release-train-issue-template.md > /tmp/release-$VERSION.md
- echo Created $(hub issue create -F /tmp/release-$VERSION.md -M $VERSION --browse)
-fi
diff --git a/scripts/release-train-issue-template.md b/scripts/release-train-issue-template.md
deleted file mode 100644
index 0cacdf53d..000000000
--- a/scripts/release-train-issue-template.md
+++ /dev/null
@@ -1,91 +0,0 @@
-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 Akka HTTP 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.
-
-Variables to be expanded in this template:
-- VERSION=???
-
-Key links:
- - akka/akka-http milestone: https://github.com/apache/incubator-pekko-http/milestone/?
--->
-
-### ~ 1 week before the release
-- [ ] Check that open PRs and issues assigned to the milestone are reasonable
-- [ ] Triage tickets that should be ready for this release, add "pick next" label and release milestone
-- [ ] Triage open PRs and apply "pick next" label and maybe add to release milestone. Some PRs might be explicitly scheduled for this release, others might be ready enough to bring them over the finish line
-Wind down PR queue. There has to be enough time after the last (non-trivial) PR is merged and the next phase. The core of the eco-system needs time to prepare for the final!
-- [ ] Decide on planned release date
-- [ ] Notify depending projects (notably Play + cinnamon) about upcoming release
-
-### 1 day before the release
-- [ ] Make sure all important / big PRs have been merged by now
-- [ ] Check that latest snapshot release still works with depending projects (notably Play + cinnamon)
-- [ ] Communicate that a release is about to be released in [Gitter Akka Dev Channel](https://gitter.im/akka/dev), so that no new Pull Requests are merged
-
-### Preparing release notes in the documentation / announcement
-
-- [ ] Create a PR to add a release notes entry in docs/src/main/paradox/release-notes/. As a helper run `scripts/commits-for-release-notes.sh <last-version-tag>` which will output a list of commits grouped by submodule, and the closed issues for this milestone
-- [ ] Create a draft PR on https://github.com/akka/akka.io with a news item (using the milestones, release notes and `scripts/authors.scala previousVersion origin/main`) and updating `_config.yml`
-- [ ] Release notes PR has been merged
-- [ ] Create a new milestone for the next version at https://github.com/apache/incubator-pekko-http/milestones
-- [ ] Move all unclosed issues to the newly created milestone (or remove milestone) and close the version you're releasing
-
-### Cutting the release
-
-- [ ] Wait until [main build finished](https://github.com/apache/incubator-pekko-http/actions/workflows/publish.yml?query=event%3Apush) after merging the release notes (otherwise, the main
- build might pick up the tag and start publishing the release uhoh)
-- [ ] Create a tag for the release (e.g. `git tag -s -a v$VERSION$ -m "Release $VERSION$"`) and push it.
-- [ ] Check that the Github Actions [release build](https://github.com/apache/incubator-pekko-http/actions/workflows/publish.yml?query=event%3Apush) executes successfully
-- [ ] Notify Telemetry / Play team to check against staged artifacts
-- [ ] Run a test against the staging repository to make sure the release went well, for example by using https://github.com/apache/incubator-pekko-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 the release on maven central: https://repo1.maven.org/maven2/org/apache/pekko/akka-http-core_2.13/$VERSION$/
-
-### When everything is on maven central
-
- - [ ] `ssh akkarepo@gustav.akka.io`
- - [ ] update the `10.2` and `current` links on `repo.akka.io` to point to the latest version with (**replace the minor appropriately**)
- ```
- ln -nsf $VERSION$ www/docs/akka-http/10.2
- ln -nsf $VERSION$ www/api/akka-http/10.2
- ln -nsf $VERSION$ www/japi/akka-http/10.2
- ln -nsf $VERSION$ www/docs/akka-http/current
- ln -nsf $VERSION$ www/api/akka-http/current
- ln -nsf $VERSION$ www/japi/akka-http/current
- ```
- - [ ] check changes and commit the new version to the local git repository
- ```
- cd ~/www
- git add docs/akka-http/ api/akka-http/ japi/akka-http/
- 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
- ```
- - [ ] Merge draft news item at https://github.com/akka/akka.io/pulls
- - [ ] Wait until the release page is published
- - [ ] Create the GitHub [release](https://github.com/apache/incubator-pekko-http/releases/tag/v$VERSION$) with the tag, title and release description linking to announcement, release notes and milestone.
-
-### Announcements
-- [ ] Send a release notification to https://discuss.akka.io
-- [ ] Tweet using the akka account (or ask someone to) about the new release
-- [ ] Announce on Gitter at https://gitter.im/akka/akka (e.g. `@/all we are happy to announce the latest Akka HTTP release $VERSION$, see https://akka.io/blog/news/XYZ for more information`)
-
-### Afterwards
-- [ ] Add the released version to `project/MiMa.scala` to the `mimaPreviousArtifacts` key *of all current compatible branches*.
-- [ ] Forward port release notes from old releases to main
-- [ ] Update Akka HTTP reference in [lightbend-platform-docs](https://github.com/lightbend/lightbend-platform-docs/blob/master/docs/modules/getting-help/examples/build.sbt#L149)
-- [ ] Update Akka HTTP reference in [akka-platform-dependencies](https://github.com/lightbend/akka-platform-dependencies/blob/main/project/Dependencies.scala)
-- [ ] Update Akka HTTP references everywhere in [akka-platform-guide](https://github.com/akka/akka-platform-guide) using the [script]([https://github.com/akka/akka-platform-guide/blob/3079fd3f8cdbef03d352ae88fb4a8d5a9b1f1be6/scripts/update-akka-http-version.sh) by running
- `scripts/update-akka-http-version.sh $VERSION$`
-- Close this issue
diff --git a/scripts/release_stats.sh b/scripts/release_stats.sh
index 430bb632f..d7c93be2a 100755
--- a/scripts/release_stats.sh
+++ b/scripts/release_stats.sh
@@ -33,10 +33,10 @@ declare author_count=$(echo "$authors" | wc -l | grep -o '[1-9].*')
declare diff_short=$(git diff --shortstat $tag_range | grep -o '[1-9].*')
declare script_user_agent="User-Agent: Akka-Stats-Script"
-declare open_milestones=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/akka/akka/milestones?state=open")
-declare closed_milestones=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/akka/akka/milestones?state=closed")
+declare open_milestones=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/apache/incubator-pekko/milestones?state=open")
+declare closed_milestones=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/apache/incubator-pekko/milestones?state=closed")
declare milestone_id=$(echo "$open_milestones$closed_milestones" | sed 's/"description"/\n/g' | perl -ne 'm/number":([0-9]+),"title":"(.+?)",/ && print "$1,$2\n"' | grep "$milestone_name" | cut -d"," -f 1)
-declare tickets=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/akka/akka/issues?milestone=$milestone_id&state=all&per_page=100" | sed 's/"comments"/\n/g' | perl -ne 'm/number":([0-9]+),"title":"(.+?)",/ && print " - *$1* $2\n"' | sort -n)
+declare tickets=$(curl -s -H "$script_user_agent" "https://api.github.com/repos/apache/incubator-pekko/issues?milestone=$milestone_id&state=all&per_page=100" | sed 's/"comments"/\n/g' | perl -ne 'm/number":([0-9]+),"title":"(.+?)",/ && print " - *$1* $2\n"' | sort -n)
declare ticket_count=$(echo "$tickets" | wc -l | grep -o '[1-9].*')
echo "$tag1 compared to Akka $tag2":
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org