cuddle-please/README.md

63 lines
1.4 KiB
Markdown
Raw Normal View History

# 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:
```bash
cuddle please release # if using cuddle
# or
cuddle-please release # if using standalone
```
And when a release has been built:
```bash
cuddle please release
# or
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
## Checklist
### 0.2 Milestone
- [x] Add docs
- [ ] Add asciinema
- [x] Create docker image
- [x] Add examples
- [x] Fx drone config
- [x] Releaser
- [x] On main/master
- [ ] tbd...
### 0.3 Milestone
- [ ] Fix: 0.0.0 -> **v**0.0.0
- [ ] Add release strategies
- [ ] Add reporter for PR and Repositories
- [ ] Add inquire for missing values when needed (when not running in ci or have a proper tty)
- [ ] Break down cuddle-please-misc
- [ ] ci(release): Add cuddle-please release artifacts for the different os and so on.
### 0.x Milestone
- [ ] Add github support
- [ ] Add custom strategies
- [ ] Add more granular tests