cuddle-please/README.md

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:

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
• Add reporter for PR and Repositories
• Setup temporary git name and email to use for git committing
• Add docker setup
• Add more granular tests

0.2 Milestone

• Add docs
• Add asciidoc
• Add examples
  • Fx drone config
    • Releaser
    • On main/master
• tbd...

0.3 Milestone

• Add inquire for missing values when needed (when not running in ci or have a proper tty)

0.x Milestone

• Add github support
• Add custom strategies
• Create docker image