cuddle-please/README.md
kjuulh fa67dfeee3
All checks were successful
continuous-integration/drone/push Build is passing
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: #9
Co-authored-by: kjuulh <contact@kjuulh.io>
Co-committed-by: kjuulh <contact@kjuulh.io>
2023-08-04 12:41:31 +00:00

1.4 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.2 Milestone

  • Add docs
  • Add asciinema
  • Create docker image
  • Add examples
    • Fx drone config
      • Releaser
      • On main/master
  • tbd...

0.3 Milestone

  • Fix: 0.0.0 -> v0.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