Add GitHub workflow for CI

.github/workflows/ci.yml

@@ -0,0 +1,132 @@
+# This file was automatically generated by sbt-github-actions using the
+# githubWorkflowGenerate task. You should add and commit this file to
+# your git repository. It goes without saying that you shouldn't edit
+# this file by hand! Instead, if you wish to make changes, you should
+# change your sbt build configuration to revise the workflow description
+# to meet your needs, then regenerate this file.
+
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches: ['**']
+  push:
+    branches: ['**']
+    tags: [v*]
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  build:
+    name: Build and Test
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        scala: [3.3.1]
+        java:
+          - temurin@8
+          - temurin@17
+          - graal_graalvm-community@17
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout current branch (full)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Java (temurin@8)
+        if: matrix.java == 'temurin@8'
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 8
+          cache: sbt
+
+      - name: Setup Java (temurin@17)
+        if: matrix.java == 'temurin@17'
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+          cache: sbt
+
+      - name: Setup GraalVM (graal_graalvm-community@17)
+        if: matrix.java == 'graal_graalvm-community@17'
+        uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: 17
+          distribution: graalvm-community
+          components: native-image
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cache: sbt
+
+      - name: Check that workflows are up to date
+        run: sbt '++ ${{ matrix.scala }}' githubWorkflowCheck
+
+      - name: Build project
+        run: sbt '++ ${{ matrix.scala }}' test
+
+      - name: Compress target directories
+        run: tar cf targets.tar target examples/target project/target
+
+      - name: Upload target directories
+        uses: actions/upload-artifact@v4
+        with:
+          name: target-${{ matrix.os }}-${{ matrix.scala }}-${{ matrix.java }}
+          path: targets.tar
+
+  publish:
+    name: Publish Artifacts
+    needs: [build]
+    if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v'))
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        scala: [3.3.1]
+        java: [temurin@8]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout current branch (full)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Java (temurin@8)
+        if: matrix.java == 'temurin@8'
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 8
+          cache: sbt
+
+      - name: Setup Java (temurin@17)
+        if: matrix.java == 'temurin@17'
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+          cache: sbt
+
+      - name: Setup GraalVM (graal_graalvm-community@17)
+        if: matrix.java == 'graal_graalvm-community@17'
+        uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: 17
+          distribution: graalvm-community
+          components: native-image
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cache: sbt
+
+      - name: Download target directories (3.3.1)
+        uses: actions/download-artifact@v4
+        with:
+          name: target-${{ matrix.os }}-3.3.1-${{ matrix.java }}
+
+      - name: Inflate target directories (3.3.1)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
+      - name: Publish project
+        run: sbt +publish

.github/workflows/clean.yml

@@ -0,0 +1,60 @@
+# This file was automatically generated by sbt-github-actions using the
+# githubWorkflowGenerate task. You should add and commit this file to
+# your git repository. It goes without saying that you shouldn't edit
+# this file by hand! Instead, if you wish to make changes, you should
+# change your sbt build configuration to revise the workflow description
+# to meet your needs, then regenerate this file.
+
+name: Clean
+
+on: push
+
+jobs:
+  delete-artifacts:
+    name: Delete Artifacts
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Delete artifacts
+        shell: bash {0}
+        run: |
+          # Customize those three lines with your repository and credentials:
+          REPO=${GITHUB_API_URL}/repos/${{ github.repository }}
+
+          # A shortcut to call GitHub API.
+          ghapi() { curl --silent --location --user _:$GITHUB_TOKEN "$@"; }
+
+          # A temporary file which receives HTTP response headers.
+          TMPFILE=$(mktemp)
+
+          # An associative array, key: artifact name, value: number of artifacts of that name.
+          declare -A ARTCOUNT
+
+          # Process all artifacts on this repository, loop on returned "pages".
+          URL=$REPO/actions/artifacts
+          while [[ -n "$URL" ]]; do
+
+            # Get current page, get response headers in a temporary file.
+            JSON=$(ghapi --dump-header $TMPFILE "$URL")
+
+            # Get URL of next page. Will be empty if we are at the last page.
+            URL=$(grep '^Link:' "$TMPFILE" | tr ',' '\n' | grep 'rel="next"' | head -1 | sed -e 's/.*<//' -e 's/>.*//')
+            rm -f $TMPFILE
+
+            # Number of artifacts on this page:
+            COUNT=$(( $(jq <<<$JSON -r '.artifacts | length') ))
+
+            # Loop on all artifacts on this page.
+            for ((i=0; $i < $COUNT; i++)); do
+
+              # Get name of artifact and count instances of this name.
+              name=$(jq <<<$JSON -r ".artifacts[$i].name?")
+              ARTCOUNT[$name]=$(( $(( ${ARTCOUNT[$name]} )) + 1))
+
+              id=$(jq <<<$JSON -r ".artifacts[$i].id?")
+              size=$(( $(jq <<<$JSON -r ".artifacts[$i].size_in_bytes?") ))
+              printf "Deleting '%s' #%d, %'d bytes\n" $name ${ARTCOUNT[$name]} $size
+              ghapi -X DELETE $REPO/actions/artifacts/$id
+            done
+          done

README.md

@@ -1,8 +1,8 @@
-## sbt project compiled with Scala 3
+## ScalaChord
 
-### Usage
+A library for choregraphic programming in Scala.
 
-This is a normal sbt project. You can compile code with `sbt compile`, run it with `sbt run`, and `sbt console` will start a Scala 3 REPL.
+The implementation is based on the paper [_HasChor: Functional Choreographic Programming for All_][haschor-paper] by Gan Shen, Shun Kashiwa and Lindsey Kuper, and its [implementation][haschor-github].
 
-For more information on the sbt-dotty plugin, see the
-[scala3-example-project](https://github.com/scala/scala3-example-project/blob/main/README.md).
+[haschor-paper]: https://dl.acm.org/doi/10.1145/3607849
+[haschor-github]: https://github.com/gshen42/HasChor

build.sbt

@@ -1,17 +1,15 @@
-lazy val common = Seq(
-  organization := "me.romac",
-  licenses := Seq(
-    "Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")
-  ),
-  homepage := Some(url("https://github.com/romac/chord")),
-  version := Versions.chord,
-  scalaVersion := Versions.scala3,
-  scalacOptions ++= Seq("-source", "3.3")
+ThisBuild / organization := "me.romac"
+ThisBuild / homepage := Some(url("https://github.com/romac/chord"))
+ThisBuild / licenses := Seq(
+  "Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")
 )
 
+ThisBuild / version := Versions.chord
+ThisBuild / scalaVersion := Versions.scala3
+ThisBuild / scalacOptions ++= Seq("-source", "3.3")
+
 lazy val root = project
   .in(file("."))
-  .settings(common)
   .settings(
     name := "chord",
     libraryDependencies ++= Seq(
@@ -24,7 +22,6 @@ lazy val root = project
 
 lazy val examples = project
   .in(file("examples"))
-  .settings(common)
   .settings(
     name := "chord-examples",
     libraryDependencies ++= Seq(
@@ -33,3 +30,40 @@ lazy val examples = project
     )
   )
   .dependsOn(root)
+
+val PrimaryJava = JavaSpec.temurin("8")
+val LTSJava = JavaSpec.temurin("17")
+val GraalVM = JavaSpec.graalvm(Graalvm.Distribution("graalvm-community"), "17")
+
+ThisBuild / githubWorkflowJavaVersions := Seq(PrimaryJava, LTSJava, GraalVM)
+
+ThisBuild / githubWorkflowTargetTags ++= Seq("v*")
+
+ThisBuild / githubWorkflowPublishTargetBranches :=
+  Seq(RefPredicate.StartsWith(Ref.Tag("v")))
+
+// ThisBuild / githubWorkflowPublish := Seq(
+//   WorkflowStep.Sbt(
+//     commands = List("ci-release"),
+//     name = Some("Publish project")
+//   )
+// )
+//
+// ThisBuild / githubWorkflowPublishTargetBranches :=
+//   Seq(
+//     RefPredicate.StartsWith(Ref.Tag("v")),
+//     RefPredicate.Equals(Ref.Branch("main"))
+//   )
+//
+// ThisBuild / githubWorkflowPublish := Seq(
+//   WorkflowStep.Sbt(
+//     commands = List("ci-release"),
+//     name = Some("Publish project"),
+//     env = Map(
+//       "PGP_PASSPHRASE" -> "${{ secrets.PGP_PASSPHRASE }}",
+//       "PGP_SECRET" -> "${{ secrets.PGP_SECRET }}",
+//       "SONATYPE_PASSWORD" -> "${{ secrets.SONATYPE_PASSWORD }}",
+//       "SONATYPE_USERNAME" -> "${{ secrets.SONATYPE_USERNAME }}"
+//     )
+//   )
+// )

project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-github-actions" % "0.22.0")