https://github.com/splitties/libpublishinghelpers
Tools for semi-auto library publishing (and other chores). Designed for Kotlin scripts.
https://github.com/splitties/libpublishinghelpers
kotlin kotlin-library kotlin-script
Last synced: 6 months ago
JSON representation
Tools for semi-auto library publishing (and other chores). Designed for Kotlin scripts.
- Host: GitHub
- URL: https://github.com/splitties/libpublishinghelpers
- Owner: Splitties
- License: apache-2.0
- Created: 2020-05-24T00:19:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T21:38:37.000Z (about 2 years ago)
- Last Synced: 2025-05-15T13:51:20.190Z (7 months ago)
- Topics: kotlin, kotlin-library, kotlin-script
- Language: Kotlin
- Homepage:
- Size: 221 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LibPublishingHelpers
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.
## Why
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 fewer ways for me to mess up (or slow down, since I'd pay extra-care to not mess up).
## Status of the project
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](TODO.md).
## Features
_This may change over time._
### Running arbitrary commands
Example: `"ls -al".execute()` will run the `ls -al` command.
### Running VCS actions
Commit files, checkout a branch, pull, pull…
(only git is supported for now)
### CLI UI
Ansi Colors, abstraction of confirmations, questions with choices selection…
Type `CliUi.` in your IDE, and discover capabilities from autocomplete.
### Check user input
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.).
### Interact with other apps
Open urls with `openUrl(…)`.
## License
This library is published under Apache License version 2.0 which you can see [here](LICENSE).