kjuulh/cuddle-please
1
0
Fork 0
Code Issues 1 Pull Requests 3 Packages Projects Releases 6 Wiki Activity
9f692c8708
cuddle-please/README.md

63 lines
1.4 KiB
Markdown
Raw Normal View History

feat: add mkdocs Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-28 22:07:07 +02:00
# Cuddle Please
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +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`.
feat: add mkdocs Signed-off-by: kjuulh <contact@kjuulh.io>
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:
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +02:00
```bash
cuddle please release # if using cuddle
# or
cuddle-please release # if using standalone
```
feat: add mkdocs Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-28 22:07:07 +02:00
And when a release has been built:
```bash
cuddle please release
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +02:00
# or
cuddle-please release
feat: add mkdocs Signed-off-by: kjuulh <contact@kjuulh.io>
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
chore: remove no-vcs option (moved to a later stage if github is someday adopted Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-31 23:00:53 +02:00
## Checklist
### 0.2 Milestone
docs(check): 0.2 milestone, forgot for 0.2.0 Signed-off-by: kjuulh <contact@kjuulh.io>
2023-08-04 14:22:36 +02:00
- [x] Add docs
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +02:00
- [ ] Add asciinema
docs(check): 0.2 milestone, forgot for 0.2.0 Signed-off-by: kjuulh <contact@kjuulh.io>
2023-08-04 14:22:36 +02:00
- [x] Create docker image
- [x] Add examples
- [x] Fx drone config
- [x] Releaser
- [x] On main/master
chore: remove no-vcs option (moved to a later stage if github is someday adopted Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-31 23:00:53 +02:00
- [ ] tbd...
### 0.3 Milestone
fix(crate): always prefix with 'v' when creating prs, or releases (#9) We don't want rust versions to include the 'v', however, many languages and tools require it. As such we're choosing when to do it, in this case at the api layer. Signed-off-by: kjuulh <contact@kjuulh.io> Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/9 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-04 14:41:31 +02:00
- [ ] Fix: 0.0.0 -> **v**0.0.0
- [ ] Add release strategies
docs(check): 0.2 milestone, forgot for 0.2.0 Signed-off-by: kjuulh <contact@kjuulh.io>
2023-08-04 14:22:36 +02:00
- [ ] Add reporter for PR and Repositories
chore: remove no-vcs option (moved to a later stage if github is someday adopted Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-31 23:00:53 +02:00
- [ ] Add inquire for missing values when needed (when not running in ci or have a proper tty)
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +02:00
- [ ] Break down cuddle-please-misc
fix(crate): always prefix with 'v' when creating prs, or releases (#9) We don't want rust versions to include the 'v', however, many languages and tools require it. As such we're choosing when to do it, in this case at the api layer. Signed-off-by: kjuulh <contact@kjuulh.io> Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/9 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-04 14:41:31 +02:00
- [ ] ci(release): Add cuddle-please release artifacts for the different os and so on.
chore: remove no-vcs option (moved to a later stage if github is someday adopted Signed-off-by: kjuulh <contact@kjuulh.io>
2023-07-31 23:00:53 +02:00
### 0.x Milestone
- [ ] Add github support
chore(release): 0.1.0 (#6) ### Added - add docker setup - refactor frontend configuration - with all the way through - with create pull request and release - with gitea - with prepend as well - add cliff - remove tokio - with doctor - with git client - with fixes - with conventional parse - with tags command - add semver - can get commit chain - with start of environment engine - with gitea client - fmt - add gitea client stub - add tests for git setup - split headings into local and global - rename to cuddle_please - add config parsing - with basic get dir - add mkdocs - add base ### Other - remove old changelog - *(deps)* update all dependencies (#2) - *(release)* 0.0.1 (#4) - release command - add cuddle.release to this repository - add granular docker setup - fix checks - chck refactor commands - move doctor command - fmt - rename release command - move gitea command into its own file - move config list - move gitea out of the way - move config building out of main execution loop - move commands and misc out of main binary package - fmt - check hide commands - move cuddle-please to cuddle-please release - remove no-vcs option (moved to a later stage if github is someday adopted - fix clippy warnings - clippy fix - fix - cleanup Reviewed-on: https://git.front.kjuulh.io/kjuulh/cuddle-please/pulls/6 Co-authored-by: kjuulh <contact@kjuulh.io> Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 22:54:26 +02:00
- [ ] Add custom strategies
- [ ] Add more granular tests
Reference in New Issue Copy Permalink