cuddle-please/README.md
kjuulh 3f0d171285
feat: add mkdocs
Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-28 22:07:07 +02:00

30 lines
674 B
Markdown

# Cuddle Please
Cuddle Please is an extension to `cuddle`, it is a separate binary that can be executed standalone as cuddle-please, or in cuddle as `cuddle please`.
The goal of the software is to be a `release-please` clone, targeting `gitea` instead of `github`.
The tool can be executed as a binary using:
`cuddle please pr create`
And when a release has been built:
```bash
cuddle please release
```
cuddle will default to information to it available in git, or use a specific entry in `cuddle.yaml` called
```yaml
# ...
please:
name: <something>
# ...
# ...
```
or as `cuddle.please.yaml`
See docs for more information about installation and some such