Skip to content

Clarify some tedious gotchas. #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: series/0.4
Choose a base branch
from
Open

Clarify some tedious gotchas. #487

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17d807d
Clarify some tedious gotchas.
dragonfly-ai Apr 5, 2023
58697b1
Update index.md
armanbilge Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

@armanbilge armanbilge Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest we move this to the FAQ. Unfortunately adding a .scalafmt.conf by itself is not the only thing you need to do to completely avoid the giter 8, so I think this might be confusing :)

```scala
version = "3.7.2"
runner.dialect = Scala213Source3
project.includePaths = [] # disables formatting
```

### Plugins

Expand Down Expand Up @@ -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.

Expand Down