2023-07-28 22:07:07 +02:00
# Cuddle Please
2023-08-01 22:54:13 +02:00
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` .
2023-07-28 22:07:07 +02:00
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:
2023-08-01 22:54:13 +02:00
```bash
cuddle please release # if using cuddle
# or
cuddle-please release # if using standalone
```
2023-07-28 22:07:07 +02:00
And when a release has been built:
```bash
cuddle please release
2023-08-01 22:54:13 +02:00
# or
cuddle-please release
2023-07-28 22:07:07 +02:00
```
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
2023-07-31 23:00:53 +02:00
## Checklist
### 0.1 Milestone
2023-07-31 23:14:18 +02:00
- [x] Hide unneccessary commands
2023-08-01 02:31:44 +02:00
- [x] Redo configuration frontend
2023-08-01 17:16:43 +02:00
- [x] Refactor command.rs into smaller bits so that bits are easier to test
2023-08-01 17:59:38 +02:00
- [x] Add cuddle.release.yaml to this repo
2023-08-01 22:41:15 +02:00
- [x] Setup temporary git name and email to use for git committing
2023-07-31 23:00:53 +02:00
### 0.2 Milestone
- [ ] Add docs
2023-08-01 22:42:34 +02:00
- [ ] Add asciinema
2023-07-31 23:00:53 +02:00
- [ ] Add examples
2023-08-01 17:17:39 +02:00
- [ ] Fx drone config
- [ ] Releaser
- [ ] On main/master
2023-08-01 22:52:08 +02:00
- [ ] Add reporter for PR and Repositories
2023-07-31 23:00:53 +02:00
- [ ] tbd...
### 0.3 Milestone
- [ ] Add inquire for missing values when needed (when not running in ci or have a proper tty)
2023-08-01 22:52:08 +02:00
- [ ] Break down cuddle-please-misc
2023-07-31 23:00:53 +02:00
### 0.x Milestone
- [ ] Add github support
2023-08-01 18:00:01 +02:00
- [ ] Add custom strategies
2023-07-31 23:00:53 +02:00
- [ ] Create docker image
2023-08-01 22:52:08 +02:00
- [ ] Add more granular tests
