fix sbt 'ci-release'

sangria-graphql · Jun 4, 2021 · 5d7d196 · 5d7d196
1 parent 0c0af0b
commit 5d7d196
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/HOW TO RELEASE.md b/HOW TO RELEASE.md
@@ -0,0 +1,25 @@
+# Release process
+
+How to create a new [release](../../releases).
+
+## Releasing
+
+The release process is automated thanks to:
+- https://github.com/djspiewak/sbt-github-actions#integration-with-sbt-ci-release
+- https://github.com/olafurpg/sbt-ci-release
+
+To release, push a git tag:
+
+```
+git tag -a v0.1.0 -m "v0.1.0"
+git push origin v0.1.0
+```
+Note that the tag version MUST start with `v`.
+
+Wait for the [CI pipeline](../../actions) to release the new version. Publishing the artifacts on maven central can take time.
+
+## Updating the release notes
+
+Open the [releases](../../releases). A draft should already be prepared.
+
+Edit the draft release to set the released version. Complete the release notes if necessary. And save it.
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -3,3 +3,4 @@ addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.8.2")
 addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.2.7")
 addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.12.0")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.2")
+addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.5.7")