From 53f5a6952bdfd2d72697f6953e8a578dac91943e Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Fri, 5 Jan 2024 23:01:57 +0100 Subject: [PATCH] Add README --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e93f602 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# woodpecker-ssg-deploy + +A Woodpecker plugin to push outputs created by SSGs into git repositories. + +## Usage + +```yaml + deploy: + image: git.polynom.me/papatutuwawa/woodpecker-ssg-deploy:latest + # The push token + # NOTE: For gitea, this is currently an access token with Read/Write access + # to repositories. + secrets: [ token ] + settings: + # The EMail to use for the git user that does the pushing + email: "system@example.org" + # The name to use for the git user that does the pushing + name: "example.org CI System" + # The name of the environment variable that contains the push token + token_env: "TOKEN" + # The name of the directory containing the SSG output + output: "public" + # The name of the branch to push into. Defaults to "pages" + branch: "pages" +``` + +What the plugin does is initialize a new Git repository in the output directory, +add all files in the output directory to the repository and then force push to the original +repository on the specified branch. + +For a real-life example [see here](https://git.polynom.me/PapaTutuWawa/blog.polynom.me). + +## License + +See `LICENSE`. \ No newline at end of file