Skip to content

Commit

Permalink
update dos
Browse files Browse the repository at this point in the history
- link to GHA page
- mention changed default value when using TypelevelCiReleasePlugin
  • Loading branch information
mzuehlke committed Jul 9, 2023
1 parent c5a520a commit 19614d9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/customization.md
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

0 comments on commit 19614d9

Please sign in to comment.