Merge pull request #15 from takapi327/feature/2022-05-Create-Release-Action

Feature/2022 05 create release action

Author: takapi327

.github/release.yml

@@ -0,0 +1,21 @@
+changelog:
+  categories:
+    - title: '🚀 Features'
+      labels:
+        - 'feature'
+    - title: '💪 Enhancement'
+      labels:
+        - 'enhancement'
+    - title: '🐛 Bug Fixes'
+      labels:
+        - 'fix'
+        - 'bugfix'
+        - 'bug'
+    - title: '🧰 Maintenance'
+      label: 'chore'
+    - title: '🔧 Refactoring'
+      label: 'refactor'
+    - title: '📖 Documentation'
+      label: 'documentation'
+    - title: '⛓️ Dependency update'
+      label: 'dependencies'

README.md

@@ -43,10 +43,25 @@ This framework relies on several libraries (automatically installed by Lepus).
 Coming soon...
 
 ## Quickstart with sbt
+Lepus Framework is not an official, publicly available plugin, but is privately maintained.
+
+Therefore, S3 is used as maven. To use Lepus Framework plug-ins from s3, the following plug-in must be configured under project/project/build.sbt of the project to be used.
+
+:warning: If it is project/build.sbt or plugin.sbt, I can't get the plugin properly and an error occurs. :warning:
+
+※ Once officially released, the following settings will no longer be necessary.
+
+in: project/project/build.sbt
+```sbt
+addSbtPlugin("com.frugalmechanic" % "fm-sbt-s3-resolver" % "0.20.0")
+```
+
 Add the following dependencies to plugins.sbt
 
+in: project/plugins.sbt
 ```sbt
-addSbtPlugin("com.github.takapi327" % "sbt-plugin" % "0.1.0-SNAPSHOT")
+ThisBuild / resolvers += "Lepus Maven" at "s3://com.github.takapi327.s3-ap-northeast-1.amazonaws.com/lepus/"
+addSbtPlugin("com.github.takapi327" % "sbt-plugin" % <version>)
 ```
 
 Load the required project with build.sbt
@@ -193,4 +208,4 @@ services:
     command: mock -h 0.0.0.0 /OpenApi.yaml
     volumes:
       - ./OpenApi.yaml:/OpenApi.yaml
-```
+```

build.sbt

@@ -28,32 +28,53 @@ ThisBuild / githubWorkflowAddedJobs ++= Seq(
   )
 )
 
+import ReleaseTransformations._
+lazy val publishSettings = Seq(
+  publishTo := Some("Lepus Maven" at "s3://com.github.takapi327.s3-ap-northeast-1.amazonaws.com/lepus/"),
+  (Compile / packageDoc) / publishArtifact := false,
+  (Compile / packageSrc) / publishArtifact := false,
+  releaseProcess := Seq[ReleaseStep](
+    checkSnapshotDependencies,
+    inquireVersions,
+    runClean,
+    runTest,
+    setReleaseVersion,
+    commitReleaseVersion,
+    tagRelease,
+    publishArtifacts,
+    setNextVersion,
+    commitNextVersion,
+    pushChanges
+  )
+)
+
 // Project settings
 lazy val LepusProject = Project("Lepus", file("core/lepus"))
   .settings(
     scalaVersion       := sys.props.get("scala.version").getOrElse(ScalaVersions.scala213),
     crossScalaVersions := Seq(scalaVersion.value),
-    commonSettings,
     scalacOptions += "-target:jvm-1.8",
     libraryDependencies ++= Seq(
       cats,
       typesafeConfig,
     ) ++ specs2Deps.map(_ % Test)
   )
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
 
 lazy val LepusRouterProject = Project("Lepus-Router", file("core/lepus-router"))
   .settings(
     scalaVersion       := (LepusProject / scalaVersion).value,
     crossScalaVersions := Seq(scalaVersion.value),
-    commonSettings,
     libraryDependencies ++= routerDependencies
   )
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
 
 lazy val LepusServerProject = Project("Lepus-Server", file("development/lepus-server"))
   .settings(
     scalaVersion       := (LepusProject / scalaVersion).value,
     crossScalaVersions := Seq(scalaVersion.value),
-    commonSettings,
     libraryDependencies ++= serverDependencies,
     (Compile / unmanagedSourceDirectories) += {
       val suffix = CrossVersion.partialVersion(scalaVersion.value) match {
@@ -63,23 +84,25 @@ lazy val LepusServerProject = Project("Lepus-Server", file("development/lepus-se
       (Compile / sourceDirectory).value / s"scala-$suffix"
     }
   )
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
   .dependsOn(LepusProject, LepusRouterProject)
 
 lazy val LepusSwaggerProject = Project("Lepus-Swagger", file("development/lepus-swagger"))
   .settings(
     scalaVersion       := (LepusProject / scalaVersion).value,
     crossScalaVersions := Seq(scalaVersion.value),
-    commonSettings,
     libraryDependencies ++= swaggerDependencies
   )
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
   .dependsOn(LepusProject, LepusRouterProject)
 
 lazy val SbtPluginProject = Project("Sbt-Plugin", file("development/sbt-plugin"))
   .enablePlugins(SbtPlugin)
   .settings(
     scalaVersion       := scala212,
     crossScalaVersions := Seq(scala212),
-    commonSettings,
     libraryDependencies ++= Seq(
       Defaults.sbtPluginExtra(
         "com.github.sbt" % "sbt-native-packager" % "1.9.7",
@@ -96,6 +119,8 @@ lazy val SbtPluginProject = Project("Sbt-Plugin", file("development/sbt-plugin")
       )
     }.taskValue
   )
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
 
 lazy val userProjects = Seq[ProjectReference](
   LepusProject,
@@ -109,8 +134,7 @@ lazy val nonUserProjects = Seq[ProjectReference](
 )
 
 lazy val LepusFramework = Project("Lepus-Framework", file("."))
-  .settings(
-    scalaVersion := sys.props.get("scala.version").getOrElse(scala213),
-    commonSettings
-  )
+  .settings(scalaVersion := sys.props.get("scala.version").getOrElse(scala213))
+  .settings(commonSettings: _*)
+  .settings(publishSettings: _*)
   .aggregate((userProjects ++ nonUserProjects): _*)

project/plugins.sbt

@@ -1,2 +1,10 @@
+/**
+ *  This file is part of the Lepus Framework.
+ *  For the full copyright and license information,
+ *  please view the LICENSE file that was distributed with this source code.
+ */
+
 addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.14.2")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.6")
+addSbtPlugin("com.frugalmechanic" % "fm-sbt-s3-resolver" % "0.20.0")
+addSbtPlugin("com.github.sbt" % "sbt-release" % "1.1.0")

version.sbt

@@ -0,0 +1 @@
+ThisBuild / version := "0.1.0"