From 9c0508c2c36cd3a399a45c3c30583e990508f845 Mon Sep 17 00:00:00 2001 From: Dorian Zedler Date: Sat, 23 Jul 2022 21:21:59 +0200 Subject: [PATCH] Docs: Add some docs --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00340c7..40aeeb7 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ A plugin to deploy to codeberg pages. Basically takes a folder and pushes it to The following settings changes this plugin's behavior. -* param1 (optional) does something. -* param2 (optional) does something different. +* folder (required) the folder to deploy. +* ssh_key (required) the ssh key to access the repo. +* git_remote (optional) the git repote to push to. Default: `$DRONE_GIT_SSH_URL` +* git_branch (optional) the branch to push to. Default: `pages` Below is an example `.drone.yml` that uses this plugin. @@ -20,6 +22,8 @@ steps: settings: folder: public ssh_key: foo + git_remote: git@somegit.com/foo/bar + git_branch: pages ``` # Building @@ -46,6 +50,10 @@ docker run --rm -e PLUGIN_FOLDER=public -e PLUGIN_SSH_KEY=foo \ -e DRONE_COMMIT_BRANCH=master \ -e DRONE_BUILD_NUMBER=43 \ -e DRONE_BUILD_STATUS=success \ + -e PLUGIN_FOLDER=public \ + -e PLUGIN_SSH_KEY="-----BEGIN OPENSSH PRIVATE KEY-----\n....." \ + -e PLUGIN_GIT_REMOTE=git@somegit.com/foo/bar \ + -e PLUGIN_GIT_BRANCH=pages \ -w /drone/src \ -v $(pwd):/drone/src \ itsblue.dev/plugins/codeberg-pages-deploy