0
0
mirror of https://github.com/thegeeklab/wp-git-action.git synced 2024-11-25 09:00:40 +00:00

cleanup docs and examples

This commit is contained in:
Robert Kaussow 2024-03-12 20:43:34 +01:00
parent 5afc6e8105
commit 1203a0aea6
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0

View File

@ -21,9 +21,6 @@ Woodpecker CI plugin to perform git actions.
## Usage ## Usage
```YAML ```YAML
kind: pipeline
name: default
steps: steps:
- name: commit changelog - name: commit changelog
image: quay.io/thegeeklab/wp-git-action image: quay.io/thegeeklab/wp-git-action
@ -31,7 +28,7 @@ steps:
action: action:
- commit - commit
- push - push
netrc_password: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM netrc_password: ghp_randomstring
author_name: octobot author_name: octobot
author_email: octobot@example.com author_email: octobot@example.com
message: "[skip ci] update changelog" message: "[skip ci] update changelog"
@ -52,21 +49,18 @@ steps:
The plugin can be used to publish GitHub pages to the pages branch. Remember that the `pages` action cannot be combined with other actions. The plugin can be used to publish GitHub pages to the pages branch. Remember that the `pages` action cannot be combined with other actions.
```YAML ```YAML
kind: pipeline
name: default
steps: steps:
- name: publish - name: publish
image: quay.io/thegeeklab/wp-git-action image: quay.io/thegeeklab/wp-git-action
settings: settings:
action: action:
- pages - pages
author_email: bot@thegeeklab.de author_email: bot@texample.com
author_name: thegeeklab-bot author_name: octocat-bot
message: "update pages" message: "update pages"
branch: gh-pages branch: gh-pages
pages_directory: docs/ pages_directory: docs/
netrc_password: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM netrc_password: ghp_randomstring
``` ```
## Build ## Build
@ -86,5 +80,12 @@ docker build --file Containerfile.multiarch --tag thegeeklab/wp-git-action .
## Test ## Test
```Shell ```Shell
docker run --rm \
-e PLUGIN_ACTION=clone \
-e PLUGIN_BRANCH=master \
-e PLUGIN_AUTHOR_EMAIL=octocat@example.copm \
-e PLUGIN_AUTHOR_NAME=octocat \
-e PLUGIN_REMOTE_URL=https://github.com/octocat/Hello-World \
-w /tmp \
thegeeklab/wp-git-action
``` ```