Skip to content

Commit 8784fec

Browse files
committed
tweak release instructions
1 parent e59b4dd commit 8784fec

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

RELEASING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Creating a regular release
22

33
1. Create a [new release](https://github.com/lightbend/genjavadoc/releases/new) with:
4-
* `git tag -a -m 'Release v0.16' v0.16`
4+
* `git tag -a -m 'Release v0.18' v0.18`
55
* title and release description including notable changes
66
2. This triggers a Github Action build that should test, build and publish to sonatype, and then close and release the repository to Maven Central.
77

@@ -10,7 +10,7 @@
1010
It is often the case when this compiler plugin needs to be released for a newly released Scala version. For this the process is the following:
1111

1212
1. Checkout the version that is to be back-released, which would be
13-
* `main`, if no features or bug fixes were merged to the main branch since the latest release. In this case create a tag recording you released from this commit, e.g. `git tag -a -m 'Release 0.16 for Scala 2.12.17' v0.16_2.12.17; git push --tags`.
13+
* `main`, if no features or bug fixes were merged to the main branch since the latest release. In this case create a tag recording you released from this commit, e.g. `git tag -a -m 'Release 0.18 for Scala 2.12.17' v0.18_2.12.17; git push --tags`.
1414
* tag, if the main branch has unreleased features or bug fixes. In this case you will need to cherry pick the commit that adds support for the new Scala version.
15-
1. Create a file `version.sbt` containing `version in ThisBuild := "0.16"` which sets the version to be back-released. This will override the automatic version derivation from the git history. Alternatively you can `set version in ThisBuild := ...` in the command line.
15+
1. Create a file `version.sbt` containing `ThisBuild / version := "0.18"` which sets the version to be back-released. This will override the automatic version derivation from the git history. Alternatively you can `set ThisBuild / version := ...` in the command line.
1616
1. Publish the release by running `SONATYPE_USERNAME=xxx SONATYPE_PASSWORD=xxx sbt clean ++2.12.17 publishSigned sonatypeBundleRelease` (with the appropriate credentials and scala version). You will need Sonatype OSS repository rights to publish under `com.typesafe` organisation.

0 commit comments

Comments
 (0)