remove Akka release train docs/scripts (#213)
* remove Akka release train docs/scripts * Delete release-drafter.yml * Update release_stats.sh
This commit is contained in:
PJ Fanning
GitHub
parent
de1a5e3b37
commit
83545a33eb
5 changed files with 3 additions and 179 deletions
22
.github/release-drafter.yml
vendored
22
.github/release-drafter.yml
vendored
|
|
@ -1,22 +0,0 @@
|
|||
template: |
|
||||
## Akka $NEXT_PATCH_VERSION Released
|
||||
|
||||
Dear hakkers,
|
||||
|
||||
We are pleased to announce a new patch release of Akka 2.6. This release includes the following changes:
|
||||
|
||||
$CHANGES
|
||||
|
||||
A total of *TODO* issues were closed since *TODO*. The complete list can be found on the *TODO* $NEXT_PATCH_VERSION milestone on GitHub.
|
||||
|
||||
# Credits
|
||||
|
||||
For this release we had the help of *TODO* committers – thank you all very much!
|
||||
|
||||
*TODO*
|
||||
|
||||
Thanks to [Lightbend](https://www.lightbend.com) for their continued sponsorship of the Akka core team's efforts. Lightbend [offers commercial support](https://www.lightbend.com/lightbend-platform-subscription) for Akka.
|
||||
|
||||
Happy hakking!
|
||||
|
||||
– The Akka Team
|
||||
75
RELEASING.md
75
RELEASING.md
|
|
@ -1,75 +0,0 @@
|
|||
# Releasing
|
||||
|
||||
Create a new issue from the [Release Train Issue Template](scripts/release-train-issue-template.md):
|
||||
|
||||
```
|
||||
$ sh ./scripts/create-release-issue.sh 0.x.y
|
||||
```
|
||||
|
||||
# Manually
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### JDK 8 and JDK 11
|
||||
|
||||
Releasing Pekko requires running on JDK 11, but also having JDK 8
|
||||
installed. The reason for this is that we want the Pekko artifacts to be
|
||||
usable with JRE 8, but also want to compile some classes with JDK11-specific
|
||||
types.
|
||||
|
||||
In the future we might be able to update the build to work
|
||||
without having JDK 8 installed, by using the `-release` option.
|
||||
|
||||
### One Time GPG and sbt-pgp setup
|
||||
|
||||
If you have not set up GPG or used `sbt-pgp` on the release machine
|
||||
* Check the [sbt-pgp usage](https://www.scala-sbt.org/sbt-pgp/usage.html) for any setup steps you may still need, for example:
|
||||
```
|
||||
sbt> set pgpReadOnly := false
|
||||
sbt> pgp-cmd gen-key
|
||||
```
|
||||
* Check that signing works with `sbt> publishLocalSigned`
|
||||
|
||||
#### Mac
|
||||
|
||||
When releasing from MacOS you may want to use YubiKey or have [MacGPG](https://gpgtools.org) installed.
|
||||
|
||||
#### Windows
|
||||
|
||||
When releasing from Windows, you need MinGW and a gpg distribution such as Gpg4Win
|
||||
|
||||
### Git
|
||||
|
||||
Make sure you have set `core.autocrlf` to `false` in your `~/.gitconfig`,
|
||||
otherwise git might convert line endings in some cases.
|
||||
|
||||
### Install Graphviz
|
||||
|
||||
[Graphvis](https://graphviz.gitlab.io/download/) is needed for the
|
||||
scaladoc generation build task, which is part of the release.
|
||||
|
||||
## Snapshot releases
|
||||
|
||||
To create snapshot versions manually, use `sbt clean publishLocal`.
|
||||
|
||||
## 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 `v2.6.4` release, then the name of the new branch should be `docs/v2.6.4`:
|
||||
```
|
||||
$ git checkout v2.6.4
|
||||
$ git checkout -b docs/v2.6.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 := "2.6.4"
|
||||
ThisBuild / isSnapshot := false
|
||||
```
|
||||
1. Switch to a new branch for your documentation change, make the change
|
||||
1. Build documentation locally with:
|
||||
```sh
|
||||
sbt docs/paradoxBrowse
|
||||
```
|
||||
1. If the generated documentation looks good, create a PR to the `docs/v2.6.4` branch you created earlier.
|
||||
1. It should automatically be published by GitHub Actions on merge.
|
||||
|
|
@ -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$2.md > /tmp/release-$VERSION.md
|
||||
echo Created $(hub issue create -F /tmp/release-$VERSION.md --browse)
|
||||
fi
|
||||
|
|
@ -1,69 +0,0 @@
|
|||
Release Akka $VERSION$
|
||||
|
||||
### Before the release
|
||||
|
||||
- [ ] Make sure all important / big PRs have been merged by now
|
||||
- [ ] Create a news item draft PR on [akka.io](https://github.com/akka/akka.io), using the milestone and `scripts/authors.scala v2.6.14 v2.6.15`
|
||||
- [ ] Make sure to update `_config.yml` in it
|
||||
- In case of a new minor release:
|
||||
- [ ] update the branch descriptions at CONTRIBUTING.md#branches-summary
|
||||
|
||||
### Cutting the release
|
||||
|
||||
- [ ] Make sure any running [actions](https://github.com/akka/akka/actions) for the commit you would like to release have completed.
|
||||
- [ ] Tag the release `git tag -a -s -m 'Release v$VERSION$' v$VERSION$` and push the tag `git push --tags`
|
||||
- [ ] Create a [new milestone](https://github.com/akka/akka/milestones) for the next version and close the current one.
|
||||
- [ ] Check that the GitHub Actions release build has executed successfully (it should publish artifacts to Sonatype and documentation to Gustav)
|
||||
- [ ] Update `MiMa.latestPatchOf` and PR that change (`project/MiMa.scala`)
|
||||
|
||||
### Check availability
|
||||
|
||||
- [ ] Check [reference](https://pekko.apache.org/docs/pekko/$VERSION$/) documentation
|
||||
- [ ] Check the release on [Maven central](https://repo1.maven.org/maven2/org/apache/pekko/pekko-actor_2.13/$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/current
|
||||
ln -nsf $VERSION$ www/api/akka/current
|
||||
ln -nsf $VERSION$ www/japi/akka/current
|
||||
```
|
||||
- [ ] check changes and commit the new version to the local git repository
|
||||
```
|
||||
cd ~/www
|
||||
git add docs/akka/current docs/akka/$VERSION$
|
||||
git add api/akka/current api/akka/$VERSION$
|
||||
git add japi/akka/current japi/akka/$VERSION$
|
||||
git commit -m "Akka $VERSION$"
|
||||
```
|
||||
- [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
|
||||
```
|
||||
cd ~/www
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### Announcements
|
||||
|
||||
- [ ] Merge draft news item for [akka.io](https://github.com/akka/akka.github.com)
|
||||
- [ ] Create a [GitHub release](https://github.com/akka/akka/releases) with the next tag version `v$VERSION$`, title and a link to the announcement
|
||||
- [ ] Post about it on the [forum](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
|
||||
|
||||
## Update references
|
||||
|
||||
Update the versions used in:
|
||||
|
||||
* [ ] https://github.com/akka/akka-samples
|
||||
* [ ] https://github.com/lightbend/lightbend-platform-docs/blob/master/docs/modules/getting-help/examples/build.sbt (this populates https://developer.lightbend.com/docs/lightbend-platform/introduction/getting-help/build-dependencies.html#_akka)
|
||||
|
||||
These are autoupdated by latest stable on maven central:
|
||||
* https://github.com/akka/akka-quickstart-java.g8
|
||||
* https://github.com/akka/akka-quickstart-scala.g8
|
||||
* https://github.com/akka/akka-http-quickstart-java.g8
|
||||
* https://github.com/akka/akka-http-quickstart-scala.g8
|
||||
* https://github.com/akka/akka-grpc-quickstart-java.g8
|
||||
* https://github.com/akka/akka-grpc-quickstart-scala.g8
|
||||
|
|
@ -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":
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue