Skip to content

Commit 8561b12

Browse files
authored
#44 sbt-ci-release process support (#45)
* #44 sbt-ci-release process support added with readme ("heavily" inspired by absa's spark-commons) * #44 release link added to README.md
1 parent 56dcd90 commit 8561b12

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,3 +175,7 @@ This approach has the advantage of being quicker, since taking samples is not so
175175
//specifying a range of values
176176
val repartitionedDfWithRange = df.repartitionByDesiredSize(sizer)(minPartitionSizeInBytes, maxPartitionSizeInBytes)
177177
```
178+
179+
## How to Release
180+
181+
Please see [this file](RELEASE.md) for more details.

RELEASE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Release
2+
3+
Releases of this library are currently handled by [sbt-ci-release](https://github.com/sbt/sbt-ci-release).
4+
Please see its documentation for more details about how it works if you are interested to know more.
5+
6+
The actual deployments are triggered manually by the maintainers of this repository, using `workflow_dispatch` event
7+
trigger.
8+
9+
Once changes from a PR were reviewed and merged into the master branch, follow these steps:
10+
1. Create a new Git Tag and push it to the repository, to the master branch. For example,
11+
if you want to release a version 0.4.0 (note that we are using [Semantic Versioning](https://semver.org/)):
12+
13+
```shell
14+
git tag -a v0.4.0 -m "v0.4.0"
15+
git push origin v0.4.0
16+
```
17+
18+
2. In GitHub UI, go to the repository's **Actions** -> **Release** -> **Run workflow**, and under **Use workflow from**
19+
use **Tags** and find the tag you created in the previous step.
20+
21+
> **Important note**: don't run the workflow against the master branch, but against the tag.
22+
> `sbt-ci-release` plugin won't be able to correctly find tag, and it will think that you are trying
23+
> to do a snapshot release, not an actual release that should be synchronized with Maven Central.

project/plugins.sbt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@ addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.6.0")
3232
addSbtPlugin("com.github.sbt" % "sbt-release" % "1.1.0")
3333
addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.1.2")
3434
addSbtPlugin("com.github.sbt" % "sbt-jacoco" % "3.4.0")
35+
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.10")

0 commit comments

Comments
 (0)