Skip to content

Commit e9daf45

Browse files
committed
docs!: Mention the change to Kotlin in the readme
1 parent 91eba7e commit e9daf45

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,17 @@ In several systems (like GitHub and Gitlab) you can have a CODEOWNERS file which
1313

1414
Reality: The syntax of these files can be tricky, and it is quite easy to write a config that has the effect that not all files are covered.
1515

16+
# Major update
17+
The upcoming 2.0.0 release has been rewritten into Kotlin. This allows for more exact checks on nullability and improves code quality.
18+
Most of the API has not been changed so using this from Java should be a simple migration.
19+
1620
# What is this
17-
1) A Java library to read a CODEOWNERS file.
18-
2) A Java library to read a/all .gitignore file(s) in directory tree.
19-
3) A Java library to validate the CODEOWNERS against the non-ignored project files.
21+
1) A Kotlin/Java library to read a CODEOWNERS file.
22+
2) A Kotlin/Java library to read a/all .gitignore file(s) in directory tree.
23+
3) A Kotlin/Java library to validate the CODEOWNERS against the non-ignored project files.
2024
3.1) This also includes the ability to validate against the actual users, groups and roles in Gitlab. (See [README-gitlab.md](README-gitlab.md))
2125
4) An extra rule for the Maven Enforcer plugin that wraps the validation library. (See Usage below)
22-
5) An example commandline script (using Koltin script) that wraps the validation library.
26+
5) An example commandline script (using Kotlin script) that wraps the validation library.
2327

2428
The intended goal is to make the build fail if the codeowners file does not cover all files and directories in the project.
2529

0 commit comments

Comments
 (0)