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.

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

fix rendering of bullet lists #588

Merged
merged 1 commit into from
Jun 30, 2023
Merged
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,41 @@ Instead of using the super-plugins, for finer-grained control you can always add

### sbt-typelevel-kernel
`TypelevelKernelPlugin`

- `tlIsScala3` (setting): `true`, if `scalaVersion` is 3.x.
- `tlSkipIrrelevantScalas` (setting): `true`, if should `skip` for `scalaVersion` not in `crossScalaVersions`.
- `tlReplaceCommandAlias` (method): Replace a `addCommandAlias` definition.
- `tlReleaseLocal` (command): Alias for `+publishLocal`.

### sbt-typelevel-versioning
`TypelevelVersioningPlugin`: Establishes a git-based, early semantic versioning scheme.

- `tlBaseVersion` (setting): The series your project is in, e.g., 0.2, 3.5.
- `tlUntaggedAreSnapshots` (setting): If true, an untagged commit is given a snapshot version, e.g. `0.4.1-17-00218f9-SNAPSHOT`. If false, it is given a release version, e.g. `0.4.1-17-00218f9` (default: true).

### sbt-typelevel-mima
`TypelevelMimaPlugin`: Determines previous MiMa artifacts via your `version` setting and git tags.

- `tlVersionIntroduced` (setting): A map `scalaBinaryVersion -> version` e.g. `Map("2.13" -> "1.5.2", "3" -> "1.7.1")` used to indicate that a particular `crossScalaVersions` value was introduced in a given version (default: empty).
- `tlMimaPreviousVersions` (setting): A set of previous versions to compare binary-compatibility against.

### sbt-typelevel-sonatype
`TypelevelSonatypePlugin`: Sets up publishing to Sonatype/Maven.

- `tlSonatypeUseLegacyHost` (setting): Publish to `oss.sonatype.org` instead of `s01.oss.sonatype.org` (default: false).
- `tlRelease` (command): Check binary-compatibility and `+publish` to Sonatype.

`TypelevelUnidocPlugin`: Sets up publishing a Scaladoc-only artifact to Sonatype/Maven.

### sbt-typelevel-settings
`TypelevelSettingsPlugin`: Good and/or opinionated defaults for scalac settings etc., inspired by sbt-tpolecat.

- `tlFatalWarnings` (setting): Convert compiler warnings into errors (default: false).
- `tlJdkRelease` (setting): JVM target version for the compiled bytecode (default: Some(8)).

### sbt-typelevel-github
`TypelevelGitHubPlugin`: Populates boilerplate settings assuming you are using GitHub.

- `tlGitHubRepo` (setting): The name of this repository on GitHub.
- `tlGitHubDev(user, fullName)` (method): Helper to create a `Developer` entry from a GitHub username.

Expand All @@ -49,6 +55,7 @@ Instead of using the super-plugins, for finer-grained control you can always add

### 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.

- `tlCiHeaderCheck` (setting): Whether to do header check in CI (default: `false`).
- `tlCiScalafmtCheck` (setting): Whether to do scalafmt check in CI (default: `false`).
- `tlCiScalafixCheck` (setting): Whether to do scalafix check in CI (default: `false`).
Expand All @@ -60,13 +67,15 @@ Instead of using the super-plugins, for finer-grained control you can always add

### sbt-typelevel-sonatype-ci-release
`TypelevelSonatypeCiReleasePlugin`: Sets up GitHub actions to publish to Sonatype in CI.

- Requires the `SONATYPE_USERNAME` and `SONATYPE_PASSWORD` secrets
- `tlCiReleaseTags` (setting): Controls whether or not v-prefixed tags should be released from CI (default `true`).
- `tlCiReleaseBranches` (setting): The branches in your repository to release from in CI on every push. Depending on your versioning scheme, they will be either snapshots or (hash) releases. Leave this empty if you only want CI releases for tags. (default: `[]`).
- `tlCiRelease` (command): Performs a `tlRelease` from the CI and reports to GH step summary.

### sbt-typelevel-ci-signing
`TypelevelCiSigningPlugin`: Sets up GitHub actions to sign your artifacts in CI.

- Requires `PGP_SECRET` secret, with your base64-encoded PGP key
- Optionally set the `PGP_PASSPHRASE` secret, but we do not recommend passphrase-protected keys for new projects. See discussion in [#9](https://github.com/typelevel/sbt-typelevel/discussions/9#discussioncomment-1251774).

Expand All @@ -75,16 +84,19 @@ Instead of using the super-plugins, for finer-grained control you can always add

### sbt-typelevel-scalafix
`TypelevelScalafixPlugin`

- `tlTypelevelScalafixVersion` (setting): The version of typelevel-scalafix to add to the scalafix dependency classpath.

### sbt-typelevel
`TypelevelPlugin`: The super-super-plugin intended for bootstrapping the typical Typelevel project. Sets up CI release including snapshots, scalac settings, headers, and formatting.

`TypelevelBspPlugin`: A plugin that controls for which cross-project platforms the `bspEnabled` setting should be set to `true`. By default it becomes enabled for `JVMPlatform` only.

- `tlBspCrossProjectPlatforms` (setting): A set of platforms for which BSP should be enabled (default: not initialized)

### sbt-typelevel-site
`TypelevelSitePlugin`: Sets up an [mdoc](https://scalameta.org/mdoc/)/[Laika](https://typelevel.org/Laika/)-generated website, automatically published to GitHub pages in CI.

- `tlSiteHelium` (setting): The Helium theme configuration and extensions.
- `tlSiteIsTypelevelProject` (setting): Indicates whether the generated site should be pre-populated with UI elements specific to Typelevel Organization or Affiliate projects (default: None).
- `tlSiteApiUrl` (setting): URL to the API docs (default: `None`).
Expand All @@ -100,6 +112,7 @@ Instead of using the super-plugins, for finer-grained control you can always add

### sbt-typelevel-mergify
`MergifyPlugin`: Sets up .mergify.yml file generation

- `mergifyPrRules` (setting): The mergify pull request rules.
- `mergifyStewardConfig` (setting): Config for the automerge rule for Scala Steward PRs, set to `None` to disable.
- `mergifyRequiredJobs` (setting): Ids for jobs that must succeed for merging (default: `[build]`).
Expand Down