plugins/codeberg-pages-deploy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Docs: Add some docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
Dorian Zedler 2022-07-23 21:21:59 +02:00
parent 4e2b785248
commit 9c0508c2c3
Signed by: dorian
GPG key ID: 989DE36109AFA354
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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. The following settings changes this plugin's behavior.
* param1 (optional) does something. * folder (required) the folder to deploy.
* param2 (optional) does something different. * 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. Below is an example `.drone.yml` that uses this plugin.
@ -20,6 +22,8 @@ steps:
settings: settings:
folder: public folder: public
ssh_key: foo ssh_key: foo
git_remote: git@somegit.com/foo/bar
git_branch: pages
``` ```
# Building # Building
@ -46,6 +50,10 @@ docker run --rm -e PLUGIN_FOLDER=public -e PLUGIN_SSH_KEY=foo \
-e DRONE_COMMIT_BRANCH=master \ -e DRONE_COMMIT_BRANCH=master \
-e DRONE_BUILD_NUMBER=43 \ -e DRONE_BUILD_NUMBER=43 \
-e DRONE_BUILD_STATUS=success \ -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 \ -w /drone/src \
-v $(pwd):/drone/src \ -v $(pwd):/drone/src \
itsblue.dev/plugins/codeberg-pages-deploy itsblue.dev/plugins/codeberg-pages-deploy