From 17d807d403d0098c7b6dac371d8cb3fc28c3a172 Mon Sep 17 00:00:00 2001 From: "dragonfly.ai" Date: Wed, 5 Apr 2023 10:20:02 -0600 Subject: [PATCH 1/2] Clarify some tedious gotchas. Reminder to add the .github/workflows/*.yml files to the git repository. A brief note about .scalafmt.conf for those who don't want to use the giter8 template. --- docs/index.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index d2c223b3..68b183f8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,6 +31,12 @@ sbt new typelevel/typelevel.g8 This will guide you through the basic setup to create a new project with **sbt-typelevel** and **sbt-typelevel-site**. Check out the [typelevel.g8](https://github.com/typelevel/typelevel.g8) project for more details. +Alternatively, if you don't want to use Giter8, you can add a file called: `.scalafmt.conf` to your project root directory with the contents: +```scala +version = "3.7.2" +runner.dialect = Scala213Source3 +project.includePaths = [] # disables formatting +``` ### Plugins @@ -116,7 +122,7 @@ lazy val tests = crossProject(JVMPlatform, JSPlatform) ### Configure GitHub Actions -Run `githubWorkflowGenerate` in sbt to automatically generate the GitHub Actions workflows. +Run `githubWorkflowGenerate` in sbt to automatically generate the GitHub Actions workflows. These consist of two YML files: `./.github/workflows/ci.yml` and `./.github/workflows/clean.yml` which you may have to add to your git repository. This will create a CI matrix parallelized on Scala version and target platform (JVM, JS, etc.) and includes steps for running tests and checking binary compatibility. It will also setup a job for publishing tagged releases e.g. `v0.4.5` and snapshots to Sonatype/Maven. From 58697b129c7d73039713756b2907167a21c65b44 Mon Sep 17 00:00:00 2001 From: Arman Bilge Date: Wed, 5 Apr 2023 10:17:29 -0700 Subject: [PATCH 2/2] Update index.md --- docs/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 68b183f8..01f111a9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -122,7 +122,8 @@ lazy val tests = crossProject(JVMPlatform, JSPlatform) ### Configure GitHub Actions -Run `githubWorkflowGenerate` in sbt to automatically generate the GitHub Actions workflows. These consist of two YML files: `./.github/workflows/ci.yml` and `./.github/workflows/clean.yml` which you may have to add to your git repository. +Run `githubWorkflowGenerate` in sbt to automatically generate the GitHub Actions workflows. +You should commit to these to your repository. This will create a CI matrix parallelized on Scala version and target platform (JVM, JS, etc.) and includes steps for running tests and checking binary compatibility. It will also setup a job for publishing tagged releases e.g. `v0.4.5` and snapshots to Sonatype/Maven.