Make freeGen2 run manually (but verified by CI)

.github/workflows/ci.yml

@@ -61,7 +61,7 @@ jobs:
         run: sbt githubWorkflowCheck
 
       - name: Test
-        run: sbt '++ ${{ matrix.scala }}' test
+        run: sbt '++ ${{ matrix.scala }}' freeGen2 test
 
       - name: Check binary compatibility
         if: matrix.java == 'temurin@11' && matrix.os == 'ubuntu-latest'

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Developing Doobie
+
+Doobie is a multi-module SBT project.
+There is some code generation (project/FreeGen2.scala) which generates the free algebra (e.g. kleisliinterpreter.scala)
+from JDBC driver classes definitions.
+
+Running the tests or building the documentation site requires connection to the example Postgres docker contains,
+which you can spin up using docker-compose:
+
+```
+docker-compose up -d --force-update
+```
+
+After that, in SBT you can run `test` to run tests, and `makeSite` to build the doc site
+
+If you're editing code generation related code, you should reload the SBT project and then run the `freeGen2` SBT task
+before compiling or running tests.
+
+# Publishing
+
+### Snapshots
+
+doobie uses [sbt-ci-release](https://github.com/olafurpg/sbt-ci-release) which means all merges to `master` are pushed to Sonatype as snapshots and there's nothing to do.
+
+### Releases
+
+To make a release, make sure you're on the right commit, then tag it using the format here. This will trigger a release build.
+
+```bash
+git tag -a v1.2.3 -m v1.2.3
+git push --tags
+```
+
+To update the doc site, check out the tag first.
+
+```
+git checkout v1.2.3
+sbt docs/publishMicrosite
+```
+
+
+

build.sbt

@@ -47,6 +47,10 @@ ThisBuild / githubWorkflowBuildPreamble ++= Seq(
     name = Some("Check Headers"),
   ),
 )
+ThisBuild / githubWorkflowBuild := {
+  val current = (ThisBuild / githubWorkflowBuild).value
+  current.updated(0, WorkflowStep.Sbt(List("freeGen2", "test"), name = Some("Test")))
+}
 ThisBuild / githubWorkflowBuildPostamble ++= Seq(
     WorkflowStep.Sbt(
       commands = List("checkGitNoUncommittedChanges"),

project/FreeGen2.scala

@@ -1,7 +1,11 @@
-import sbt._, Keys._
-import java.lang.reflect._
+import sbt.*
+import Keys.*
+
+import java.lang.reflect.*
 import scala.reflect.ClassTag
-import Predef._
+import Predef.*
+import org.typelevel.sbt.gha.GenerativeKeys.githubWorkflowBuild
+import org.typelevel.sbt.gha.GenerativePlugin.autoImport.WorkflowStep
 
 object FreeGen2 {
 
@@ -26,7 +30,6 @@ object FreeGen2 {
         freeGen2KleisliInterpreterImportExcludes.value,
         state.value.log
       ).gen(freeGen2Dir.value),
-    Compile / compile := (Compile / compile).dependsOn(freeGen2).value
   )
 
 }