This is a library for library projects.
It is designed to be included as a dependency in a Kotlin 1.3.70+ script (e.g. Releasing.main.kts
).
It brings helpers/tools to make a readable and maintainable releasing script, avoiding errors in the critical process of tagging and releasing a library.
Because releasing new versions of Splitties, refreshVersions and other library projects is a chore to me, and it's error-prone, especially since it's boring.
I want it to be fun
and reliable instead, so I made this library to be used in Kotlin scripts for library version releasing. That makes the process semi-automatic, with less ways for me to mess-up (or slow down, since I'd pay extra-care to not mess up).
For now, there's no release of the built library on a public repository as I'm experimenting locally.
While non dev releases are stable enough to be used safely enough (but at your own risk), the API is not stable, which means it might change from a release to another, requiring updates to the source code.
To check what's on the table for that project, check out the TODO file.
This may change over time.
Example: "ls -al".execute()
will run the ls -al
command.
Commit files, checkout a branch, pull, pull…
(only git is supported for now)
Ansi Colors, abstraction of confirmations, questions with choices selection…
Type CliUi.
in your IDE, and discover capabilities from autocomplete.
The checkIsValidVersionString()
extension function for String?
can help you ensure a valid version has been entered in a versioning + releasing script (outlawing non digital prefixes, illegal characters such as spaces, etc.).
Open urls with openUrl(…)
.
This library is published under Apache License version 2.0 which you can see here.