Release publishing flow

.github/workflows/pr.yml

@@ -0,0 +1,27 @@
+name: Pull Request
+on:
+  pull_request:
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        scala: [ "2.12.15", "2.13.8" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: olafurpg/setup-scala@v13
+        with:
+          java-version: [email protected]
+      - uses: coursier/[email protected]
+      - run: sbt ++${{ matrix.scala }} test
+
+  format:
+    name: Check formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: olafurpg/setup-scala@v13
+        with:
+          java-version: [email protected]
+      - run: sbt scalafmtCheckAll

.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish Release
+on:
+  push:
+    branches: [master, main]
+    tags: ["*"]
+jobs:
+  publish:
+    name: Publish to Sonatype Releases
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: olafurpg/setup-scala@v13
+        with:
+          java-version: [email protected]
+      - uses: coursier/[email protected]
+      - run: sudo apt update && sudo apt install -y gnupg
+      - run: echo $PGP_SECRET | base64 --decode | gpg --batch --import
+        env:
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+      - run: sbt +test ciReleaseTagNextVersion ciReleaseSonatype
+        env:
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

.gitignore

@@ -5,6 +5,7 @@ test_run_dir/
 *.fir
 *.f
 *.anno.json
+/gnupg-*
 
 ### XilinxISE template
 # intermediate build files
@@ -326,6 +327,7 @@ lib_managed/
 src_managed/
 project/boot/
 project/plugins/project/
+.bsp
 
 # Scala-IDE specific
 .scala_dependencies

README.md

@@ -3,7 +3,7 @@ Barstools
 
 ---
 
-![Test](https://github.com/freechipsproject/ucb-bar/barstools/Test/badge.svg)
+![CI Status](https://github.com/ucb-bar/barstools/actions/workflows/publish.yml/badge.svg)
 
 **Barstools** is a collection of useful utilities for BAR projects
 

build.sbt

@@ -1,31 +1,57 @@
 // See LICENSE for license details.
 
+enablePlugins(GitVersioning)
+addCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % defaultVersions("chisel3") cross CrossVersion.full)
+
 val defaultVersions = Map(
-  "chisel3" -> "3.5.1",
+  "chisel3" -> "3.5.3",
   "chisel-iotesters" -> "2.5.1"
 )
 
-organization := "edu.berkeley.cs"
-version := "0.4-SNAPSHOT"
-name := "tapeout"
-scalaVersion := "2.12.13"
-crossScalaVersions := Seq("2.12.13", "2.13.6")
-scalacOptions := Seq("-deprecation", "-feature", "-language:reflectiveCalls")
-Test / scalacOptions ++= Seq("-language:reflectiveCalls")
-fork := true
-mainClass := Some("barstools.macros.MacroCompiler")
-libraryDependencies ++= Seq("chisel3","chisel-iotesters").map {
-  dep: String => "edu.berkeley.cs" %% dep % sys.props.getOrElse(dep + "Version", defaultVersions(dep))
-}
-libraryDependencies ++= Seq(
-  "com.typesafe.play" %% "play-json" % "2.9.2",
-  "org.scalatest" %% "scalatest" % "3.2.9" % "test",
-  "org.apache.logging.log4j" % "log4j-api" % "2.11.2",
-  "org.apache.logging.log4j" % "log4j-core" % "2.11.2"
+lazy val buildSettings = Seq(
+  organization := "edu.berkeley.cs",
+  // version computed by sbt-ci-release-early
+  name := "barstools",
+  scalaVersion := "2.12.15",
+  crossScalaVersions := Seq("2.12.15", "2.13.8"),
+  scalacOptions := Seq("-deprecation", "-feature", "-language:reflectiveCalls"),
+
+  Test / scalacOptions ++= Seq("-language:reflectiveCalls"),
+  fork := true,
+
+  mainClass := Some("barstools.macros.MacroCompiler"),
+
+  libraryDependencies ++= (Seq("chisel3","chisel-iotesters").map {
+    dep: String => "edu.berkeley.cs" %% dep % sys.props.getOrElse(dep + "Version", defaultVersions(dep))
+  }),
+
+  libraryDependencies ++= Seq(
+    "com.typesafe.play" %% "play-json" % "2.9.2",
+    "org.apache.logging.log4j" % "log4j-api" % "2.18.0",
+    "org.apache.logging.log4j" % "log4j-core" % "2.18.0",
+    "org.scalatest" %% "scalatest" % "3.2.9" % "test"
+  ),
+
+  resolvers ++= Seq(
+    Resolver.sonatypeRepo("snapshots"),
+    Resolver.sonatypeRepo("releases"),
+    Resolver.mavenLocal
+  )
 )
-addCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % defaultVersions("chisel3") cross CrossVersion.full)
-resolvers ++= Seq(
-  Resolver.sonatypeRepo("snapshots"),
-  Resolver.sonatypeRepo("releases"),
-  Resolver.mavenLocal
+
+lazy val publishSettings = Seq(
+  scmInfo := Some(ScmInfo(
+      url("https://github.com/ucb-bar/barstools"),
+      "scm:[email protected]:ucb-bar/barstools.git")),
+  licenses := List("BSD 3-Clause" -> url("https://opensource.org/licenses/BSD-3-Clause")),
+  developers := List(Developer("edwardcwang", "Edward Wang", "", url("https://github.com/edwardcwang")), Developer("chick", "Chick Markley", "", url("https://github.com/chick"))),
+  homepage := Some(url("https://github.com/ucb-bar/barstools/")),
+  publishTo := sonatypePublishToBundle.value,
+
+  Test / publishArtifact := false,
+  publishMavenStyle := true
 )
+
+lazy val barstools = (project in file("."))
+  .settings(buildSettings)
+  .settings(publishSettings)

project/build.properties

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

project/plugins.sbt

@@ -1,3 +1,4 @@
 addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.5")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.3")
 addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.9.2")
+addSbtPlugin("io.shiftleft" % "sbt-ci-release-early" % "2.0.32")

src/test/scala/barstools/tapeout/transforms/GenerateTopSpec.scala

@@ -13,7 +13,7 @@ class GenerateTopSpec extends AnyFreeSpec with Matchers {
   "Generate top and harness" - {
     "should include the following transforms" in {
       val targetDir = "test_run_dir/generate_top_and_harness"
-      val transformListName = s"$targetDir/ExampleModuleNeesResetInvertTransforms.log"
+      val transformListName = s"$targetDir/ExampleModuleNeedsResetInvertTransforms.log"
       FileUtils.makeDirectory(targetDir)
       (new ChiselStage).emitChirrtl(new ExampleModuleNeedsResetInverted, Array("--target-dir", targetDir))
 
@@ -24,7 +24,11 @@ class GenerateTopSpec extends AnyFreeSpec with Matchers {
           "-ll",
           "info",
           "--log-file",
-          transformListName
+          transformListName,
+          "-o",
+          s"$targetDir/ExampleModuleNeedsResetInverted.top.v",
+          "-tho",
+          s"$targetDir/ExampleModuleNeedsResetInverted.harness.v"
         )
       )