Merge series/0.4 -> main

.github/workflows/ci.yml

@@ -33,12 +33,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -72,11 +81,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: mkdir -p github/target github-actions/target kernel/target versioning/target ci-release/target target .js/target mdocs/target site/target ci-signing/target mima/target .jvm/target .native/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
+        run: mkdir -p github/target github-actions/target kernel/target versioning/target ci-release/target target .js/target mdocs/target site/target ci-signing/target mergify/target unidoc/target mima/target .jvm/target .native/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: tar cf targets.tar github/target github-actions/target kernel/target versioning/target ci-release/target target .js/target mdocs/target site/target ci-signing/target mima/target .jvm/target .native/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
+        run: tar cf targets.tar github/target github-actions/target kernel/target versioning/target ci-release/target target .js/target mdocs/target site/target ci-signing/target mergify/target unidoc/target mima/target .jvm/target .native/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
@@ -101,12 +110,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -135,22 +153,23 @@ jobs:
         env:
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
-        run: echo $PGP_SECRET | base64 -d | gpg --import
+        run: echo $PGP_SECRET | base64 -di | gpg --import
 
       - name: Import signing key and strip passphrase
         if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != ''
         env:
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
         run: |
-          echo "$PGP_SECRET" | base64 -d > /tmp/signing-key.gpg
+          echo "$PGP_SECRET" | base64 -di > /tmp/signing-key.gpg
           echo "$PGP_PASSPHRASE" | gpg --pinentry-mode loopback --passphrase-fd 0 --import /tmp/signing-key.gpg
           (echo "$PGP_PASSPHRASE"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1)
 
       - name: Publish
         env:
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_CREDENTIAL_HOST: ${{ secrets.SONATYPE_CREDENTIAL_HOST }}
         run: sbt '++${{ matrix.scala }}' tlRelease
 
   site:
@@ -167,12 +186,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -195,4 +223,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: mdocs/target/docs/site
-          publish_branch: gh-pages
+          keep_files: true

.mergify.yml

@@ -0,0 +1,162 @@
+# This file was automatically generated by sbt-typelevel-mergify using the
+# mergifyGenerate 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 mergify configuration
+# to meet your needs, then regenerate this file.
+
+pull_request_rules:
+- name: merge scala-steward's PRs
+  conditions:
+  - author=scala-steward
+  - or:
+    - body~=labels:.*early-semver-patch
+    - body~=labels:.*early-semver-minor
+  - status-success=Build and Test (ubuntu-latest, 2.12.15, temurin@8, rootJVM)
+  - '#approved-reviews-by>=1'
+  actions:
+    merge: {}
+- name: Label ci PRs
+  conditions:
+  - files~=^ci/
+  actions:
+    label:
+      add:
+      - ci
+      remove: []
+- name: Label ci-release PRs
+  conditions:
+  - files~=^ci-release/
+  actions:
+    label:
+      add:
+      - ci-release
+      remove: []
+- name: Label ci-signing PRs
+  conditions:
+  - files~=^ci-signing/
+  actions:
+    label:
+      add:
+      - ci-signing
+      remove: []
+- name: Label core PRs
+  conditions:
+  - files~=^core/
+  actions:
+    label:
+      add:
+      - core
+      remove: []
+- name: Label docs PRs
+  conditions:
+  - files~=^docs/
+  actions:
+    label:
+      add:
+      - docs
+      remove: []
+- name: Label github PRs
+  conditions:
+  - files~=^github/
+  actions:
+    label:
+      add:
+      - github
+      remove: []
+- name: Label github-actions PRs
+  conditions:
+  - files~=^github-actions/
+  actions:
+    label:
+      add:
+      - github-actions
+      remove: []
+- name: Label kernel PRs
+  conditions:
+  - files~=^kernel/
+  actions:
+    label:
+      add:
+      - kernel
+      remove: []
+- name: Label mdocs PRs
+  conditions:
+  - files~=^mdocs/
+  actions:
+    label:
+      add:
+      - mdocs
+      remove: []
+- name: Label mergify PRs
+  conditions:
+  - files~=^mergify/
+  actions:
+    label:
+      add:
+      - mergify
+      remove: []
+- name: Label mima PRs
+  conditions:
+  - files~=^mima/
+  actions:
+    label:
+      add:
+      - mima
+      remove: []
+- name: Label no-publish PRs
+  conditions:
+  - files~=^no-publish/
+  actions:
+    label:
+      add:
+      - no-publish
+      remove: []
+- name: Label settings PRs
+  conditions:
+  - files~=^settings/
+  actions:
+    label:
+      add:
+      - settings
+      remove: []
+- name: Label site PRs
+  conditions:
+  - files~=^site/
+  actions:
+    label:
+      add:
+      - site
+      remove: []
+- name: Label sonatype PRs
+  conditions:
+  - files~=^sonatype/
+  actions:
+    label:
+      add:
+      - sonatype
+      remove: []
+- name: Label sonatype-ci-release PRs
+  conditions:
+  - files~=^sonatype-ci-release/
+  actions:
+    label:
+      add:
+      - sonatype-ci-release
+      remove: []
+- name: Label unidoc PRs
+  conditions:
+  - files~=^unidoc/
+  actions:
+    label:
+      add:
+      - unidoc
+      remove: []
+- name: Label versioning PRs
+  conditions:
+  - files~=^versioning/
+  actions:
+    label:
+      add:
+      - versioning
+      remove: []

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.4.0
+version = 3.4.3
 
 runner.dialect = scala212source3
 

README.md

@@ -1,28 +1,16 @@
-# sbt-typelevel [![sbt-typelevel Scala version support](https://index.scala-lang.org/typelevel/sbt-typelevel/sbt-typelevel/latest-by-scala-version.svg?targetType=Sbt)](https://index.scala-lang.org/typelevel/sbt-typelevel/sbt-typelevel)
+# sbt-typelevel [![sbt-typelevel Scala version support](https://index.scala-lang.org/typelevel/sbt-typelevel/sbt-typelevel/latest-by-scala-version.svg?targetType=Sbt)](https://index.scala-lang.org/typelevel/sbt-typelevel/sbt-typelevel) [![Discord](https://img.shields.io/discord/632277896739946517.svg?label=&logo=discord&logoColor=ffffff&color=404244&labelColor=6A7EC2)](https://discord.gg/D7wY3aH7BQ)
 
-sbt-typelevel helps Scala projects to publish early-semantically-versioned, binary-compatible artifacts to Sonatype/Maven from GitHub actions. It is a collection of plugins that work well individually and even better together.
+sbt-typelevel configures [sbt](https://www.scala-sbt.org/) for developing, testing, cross-building, publishing, and documenting your Scala library on GitHub, with a focus on semantic versioning and binary compatibility. It is a collection of plugins that work well individually and even better together.
 
-## Quick start
-```scala
-// Pick one, for project/plugins.sbt
+## Features
 
-// Full service, batteries-included, let's go!
-addSbtPlugin("org.typelevel" % "sbt-typelevel" % "<version>")
+- Auto-generated GitHub actions workflows, parallelized on Scala version and platform (JVM, JS, Native)
+- git-based dynamic versioning
+- Binary-compatibility checking with [MiMa](https://github.com/lightbend/mima), following [early semantic versioning](https://www.scala-lang.org/blog/2021/02/16/preventing-version-conflicts-with-versionscheme.html#early-semver-and-sbt-version-policy)
+- CI publishing of releases and snapshots to Sonatype/Maven
+- CI deployed GitHub pages websites generated with [mdoc](https://github.com/scalameta/mdoc/) and [Laika](https://github.com/planet42/laika)
+- Auto-populated settings for various boilerplate (SCM info, API doc urls, Scala.js sourcemaps, etc.)
 
-// Set me up for CI release, but don't touch my scalacOptions!
-addSbtPlugin("org.typelevel" % "sbt-typelevel-ci-release" % "<version>")
+## Get Started
 
-// Then, in your build.sbt
-ThisBuild / tlBaseVersion := "0.4" // your current series x.y
-ThisBuild / developers +=
-  tlGitHubDev("armanbilge", "Arman Bilge") // your GitHub handle and name
-```
-
-Next, run `githubWorkflowGenerate` in sbt to automatically generate the GitHub Actions workflows.
-
-Finally, on GitHub set the following secrets on your repository:
-- `SONATYPE_USERNAME` and `SONATYPE_PASSWORD`
-- `PGP_SECRET`: output of `gpg --armor --export-secret-keys $LONG_ID | base64`
-- `PGP_PASSPHRASE` (optional, use only if your key is passphrase-protected)
-
-Visit https://typelevel.org/sbt-typelevel for detailed documentation.
+Visit https://typelevel.org/sbt-typelevel for a quick start example and detailed documentation.

build.sbt

@@ -10,12 +10,17 @@ ThisBuild / developers := List(
   tlGitHubDev("djspiewak", "Daniel Spiewak")
 )
 
+ThisBuild / mergifyStewardConfig ~= { _.map(_.copy(mergeMinors = true)) }
+ThisBuild / mergifySuccessConditions += MergifyCondition.Custom("#approved-reviews-by>=1")
+ThisBuild / mergifyLabelPaths += { "docs" -> file("docs") }
+
 lazy val root = tlCrossRootProject.aggregate(
   kernel,
   noPublish,
   settings,
   github,
   githubActions,
+  mergify,
   versioning,
   mima,
   sonatype,
@@ -25,6 +30,7 @@ lazy val root = tlCrossRootProject.aggregate(
   core,
   ciRelease,
   site,
+  unidoc,
   docs
 )
 
@@ -65,6 +71,15 @@ lazy val githubActions = project
     name := "sbt-typelevel-github-actions"
   )
 
+lazy val mergify = project
+  .in(file("mergify"))
+  .enablePlugins(SbtPlugin)
+  .settings(
+    name := "sbt-typelevel-mergify",
+    tlVersionIntroduced := Map("2.12" -> "0.4.6")
+  )
+  .dependsOn(githubActions)
+
 lazy val versioning = project
   .in(file("versioning"))
   .enablePlugins(SbtPlugin)
@@ -146,9 +161,28 @@ lazy val site = project
   .settings(
     name := "sbt-typelevel-site"
   )
-  .dependsOn(kernel, githubActions, noPublish)
+  .dependsOn(kernel, github, githubActions, noPublish)
+
+lazy val unidoc = project
+  .in(file("unidoc"))
+  .enablePlugins(TypelevelUnidocPlugin)
+  .settings(
+    name := "sbt-typelevel-docs"
+  )
 
 lazy val docs = project
   .in(file("mdocs"))
   .enablePlugins(TypelevelSitePlugin)
-  .settings(laikaConfig ~= { _.withRawContent })
+  .settings(
+    laikaConfig ~= { _.withRawContent },
+    tlSiteApiPackage := Some("org.typelevel.sbt"),
+    tlSiteRelatedProjects := Seq(
+      "sbt" -> url("https://www.scala-sbt.org/"),
+      "sbt-crossproject" -> url("https://github.com/portable-scala/sbt-crossproject"),
+      "sbt-github-actions" -> url("https://github.com/djspiewak/sbt-github-actions/"),
+      "mima" -> url("https://github.com/lightbend/mima"),
+      "mdoc" -> url("https://scalameta.org/mdoc/"),
+      "Laika" -> url("https://planet42.github.io/Laika/"),
+      "sbt-unidoc" -> url("https://github.com/sbt/sbt-unidoc")
+    )
+  )