#26 library release using sbt-ci-release plugin (#27)

#26 library release using sbt-ci-release plugin

Author: lsulak

.github/CODEOWNERS

@@ -1 +1,4 @@
-* @Zejnilovic @dk1844 @benedeki @AdrianOlosutean
+* @Zejnilovic
+* @dk1844
+* @benedeki
+* @lsulak

.github/workflows/release.yml

@@ -0,0 +1,34 @@
+#
+# Copyright 2022 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: Release
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+      - uses: olafurpg/setup-scala@v13
+      - run: sbt ci-release
+        env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

README.md

@@ -1,5 +1,8 @@
 # Spark Data Standardization Library
 
+[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+[![Release](https://github.com/AbsaOSS/spark-data-standardization/actions/workflows/release.yml/badge.svg)](https://github.com/AbsaOSS/spark-data-standardization/actions/workflows/release.yml)
+
 - Dataframe in 
 - Standardized Dataframe out
 
@@ -34,3 +37,7 @@ Spark and Scala compatibility
 >| | Scala 2.11 | Scala 2.12 |
 >|---|---|---|
 >|Spark| 2.4.X | 3.2.1 |
+
+## How to Release
+
+Please see [this file](RELEASE.md) for more details.

RELEASE.md

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

build.sbt

@@ -17,14 +17,15 @@ import sys.process._
 
 ThisBuild / name := "spark-data-standardization"
 ThisBuild / organization := "za.co.absa"
-ThisBuild / version := "0.0.1-SNAPSHOT"
 
 lazy val scala211 = "2.11.12"
 lazy val scala212 = "2.12.12"
 
 ThisBuild / crossScalaVersions := Seq(scala211, scala212)
 ThisBuild / scalaVersion := scala211
 
+ThisBuild / versionScheme := Some("early-semver")
+
 def sparkVersion(scalaVersion: String): String = if (scalaVersion==scala212) "3.2.1" else "2.4.7"
 
 def sparkFastTestsVersion(scalaVersion: String): String = if (scalaVersion == scala212) "1.1.0" else "0.23.0"
@@ -60,10 +61,5 @@ lazy val baseBranchName = (
 
 scalafmtFilter.withRank(KeyRanks.Invisible) := s"diff-ref=${baseBranchName}"
 
-// licenceHeader check:
-ThisBuild / organizationName := "ABSA Group Limited"
-ThisBuild / startYear := Some(2021)
-ThisBuild / licenses += "Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0.txt")
-
 // linting
 Global / excludeLintKeys += ThisBuild / name // will be used in publish, todo #3 - confirm if lint ignore is still needed

project/build.properties

@@ -1 +1 @@
-sbt.version=1.5.5
+sbt.version=1.6.2

project/plugins.sbt

@@ -1,2 +1,21 @@
+/*
+ * Copyright 2022 ABSA Group Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.10")
+
 addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.7.0")
+
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.5")

publish.sbt

@@ -14,13 +14,10 @@
  * limitations under the License.
  */
 
-// to successfully publish to Sonatype OSS (using sbt publishSigned), setup outline at
-// https://www.scala-sbt.org/1.x/docs/Using-Sonatype.html is expected
-
 ThisBuild / organizationHomepage := Some(url("https://www.absa.africa"))
 ThisBuild / scmInfo := Some(
   ScmInfo(
-    browseUrl = url("http://github.com/AbsaOSS/spark-data-standardization/tree/master"),
+    browseUrl = url("https://github.com/AbsaOSS/spark-data-standardization/tree/master"),
     connection = "scm:git:git://github.com/AbsaOSS/spark-data-standardization.git",
     devConnection = "scm:git:ssh://github.com/AbsaOSS/spark-data-standardization.git"
   )
@@ -38,19 +35,31 @@ ThisBuild / developers := List(
     name  = "Daniel Kavan",
     email = "[email protected]",
     url   = url("https://github.com/dk1844")
+  ),
+  Developer(
+    id    = "benedeki",
+    name  = "David Benedeki",
+    email = "[email protected]",
+    url   = url("https://github.com/benedeki")
+  ),
+  Developer(
+    id    = "AdrianOlosutean",
+    name  = "Adrian Olosutean",
+    email = "[email protected]",
+    url   = url("https://github.com/AdrianOlosutean")
+  ),
+  Developer(
+    id    = "lsulak",
+    name  = "Ladislav Sulak",
+    email = "[email protected]",
+    url   = url("https://github.com/lsulak")
   )
 )
 
 ThisBuild / homepage := Some(url("https://github.com/AbsaOSS/spark-data-standardization"))
 ThisBuild / description := "Data Standardization library (originally part of the Enceladus project)"
 
-ThisBuild / pomIncludeRepository := { _ => false }
-ThisBuild / publishTo := {
-  val nexus = "https://oss.sonatype.org/"
-  if (isSnapshot.value) {
-    Some("snapshots" at s"${nexus}content/repositories/snapshots")
-  } else {
-    Some("releases" at s"${nexus}service/local/staging/deploy/maven2")
-  }
-}
-ThisBuild / publishMavenStyle := true
+// licenceHeader check:
+ThisBuild / organizationName := "ABSA Group Limited"
+ThisBuild / startYear := Some(2021)
+ThisBuild / licenses += "Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0.txt")