Skip to content
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

update docs #603

Merged
merged 1 commit into from
Jul 9, 2023
+11 −0
Merged

update docs #603

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ Instead of using the super-plugins, for finer-grained control you can always add

`TypelevelScalaNativeGitHubPlugin`: Points your sourcemaps to GitHub permalinks. Only activated for Scala Native projects.

### sbt-typelevel-github-actions
`GitHubActionsPlugin`: Provides general functionality, giving builds the ability to introspect on their host workflow and whether or not they are running in GitHub Actions.

`GenerativePlugin`: Makes it easier to maintain GitHub Actions builds for sbt projects by generating ci.yml and clean.yml workflow definition files.

Both plugins are documented in [**sbt-typelevel-github-actions**](gha.md).

### sbt-typelevel-ci
`TypelevelCiPlugin`: Sets up GitHub actions to run tests and submit dependencies for vulnerability scanning. You can optionally enable checks for headers, formatting, scalafix, MiMa, and scaladoc.

Expand Down Expand Up @@ -80,6 +87,10 @@ Instead of using the super-plugins, for finer-grained control you can always add

### sbt-typelevel-ci-release
`TypelevelCiReleasePlugin`: The super-plugin that sets you up with versioning, mima, signing, and sonatype publishing, all in GitHub actions.
Using this plugin the following 2 settings have new default values:

- `tlCiMimaBinaryIssueCheck` (setting): Whether to do MiMa binary issues check in CI (default: `true`).
- `tlCiDocCheck` (setting): Whether to build API docs in CI (default: `true`).

### sbt-typelevel-scalafix
`TypelevelScalafixPlugin`
Expand Down