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

Jump to bottom

Update Readme: suggest controlling ktlint version manually #233

Merged
merged 1 commit into from
Jun 16, 2024
Merged

Update Readme: suggest controlling ktlint version manually #233

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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,23 @@ plugins {
}
```

##### (Optional) Managing `ktlint` version with Renovate/Dependaot
Given the plugin is just a wrapper and follows its own release cycle, it may a good practice to manually control `ktlint` tool version. One can achieve it by defining full ktlint version dependency and passing resolved ktlint version to the `ktlint` extension. Version Catalog example:
```toml
[versions]
ktlint = "x.y.z"

[libraries]
ktlint-core = { module = "com.pinterest.ktlint:ktlint-cli", version.ref = "ktlint" }
```
\+ then
```groovy
ktlint {
ktlinVersion = libs.versions.ktlint.get()
}
```


### Compatibility

| plugin version | min gradle version | min ktlint version |
Expand Down
Loading