-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #136 from sangria-graphql/automate_release
automate release
- Loading branch information
Showing
3 changed files
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/sbt/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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.14.2") | ||
addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.1.0") | ||
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.6") | ||
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.10") |