cuddle-please/README.md
kjuulh dbfb2064d2 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: #6
Co-authored-by: kjuulh <contact@kjuulh.io>
Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-01 20:54:26 +00:00

1.5 KiB

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 release # if using cuddle
# or
cuddle-please release # if using standalone

And when a release has been built:

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

# ...
please:
  name: <something>  
  # ...
# ...

or as cuddle.please.yaml

See docs for more information about installation and some such

Checklist

0.1 Milestone

  • Hide unneccessary commands
  • Redo configuration frontend
  • Refactor command.rs into smaller bits so that bits are easier to test
  • Add cuddle.release.yaml to this repo
  • Setup temporary git name and email to use for git committing

0.2 Milestone

  • Add docs
  • Add asciinema
  • Add examples
    • Fx drone config
      • Releaser
      • On main/master
  • Add reporter for PR and Repositories
  • tbd...

0.3 Milestone

  • Add inquire for missing values when needed (when not running in ci or have a proper tty)
  • Break down cuddle-please-misc

0.x Milestone

  • Add github support
  • Add custom strategies
  • Create docker image
  • Add more granular tests