diff --git a/README.md b/README.md new file mode 100644 index 0000000..51c1053 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# 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: + +```bash +cuddle please release +``` + +cuddle will default to information to it available in git, or use a specific entry in `cuddle.yaml` called + +```yaml +# ... +please: + name: + # ... +# ... +``` + +or as `cuddle.please.yaml` + +See docs for more information about installation and some such diff --git a/cuddle.yaml b/cuddle.yaml index 15c1958..c66acea 100644 --- a/cuddle.yaml +++ b/cuddle.yaml @@ -5,4 +5,11 @@ base: "git@git.front.kjuulh.io:kjuulh/cuddle-base.git" vars: service: "cuddle-release" registry: kasperhermansen + mkdocs_image: "squidfunk/mkdocs-material:9.1" +scripts: + "mkdocs:new": + type: shell + "mkdocs:dev": + type: shell + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..87fac82 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,21 @@ +site_name: cuddle-please +theme: + name: material + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: deep-orange + accent: deep orange + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: deep orange + accent: deep orange + toggle: + icon: material/brightness-4 + name: Switch to light mode # Palette toggle for light mode diff --git a/scripts/mkdocs:dev.sh b/scripts/mkdocs:dev.sh new file mode 100755 index 0000000..af5a5e4 --- /dev/null +++ b/scripts/mkdocs:dev.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +set -e + +docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ${MKDOCS_IMAGE} diff --git a/scripts/mkdocs:new.sh b/scripts/mkdocs:new.sh new file mode 100755 index 0000000..8410ed1 --- /dev/null +++ b/scripts/mkdocs:new.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +set -e + +docker run --rm -it -v ${PWD}:/docs ${MKDOCS_IMAGE} new .