wp-git-action/docs/content/_index.md

title
wp-git-action

Woodpecker CI plugin to perform git actions.

{{< toc >}}

Usage

steps:
  - name: commit changelog
    image: quay.io/thegeeklab/wp-git-action
    settings:
      action:
        - commit
        - push
      netrc_password: ghp_randomstring
      author_name: octobot
      author_email: octobot@example.com
      message: "[skip ci] update changelog"

Parameters

{{< propertylist name=wp-git-action.data sort=name >}}

Examples

Publish GitHub pages

The plugin can be used to publish GitHub pages to the pages branch. Remember that the pages action cannot be combined with other actions.

steps:
  - name: publish
    image: quay.io/thegeeklab/wp-git-action
    settings:
      action:
        - pages
      author_email: bot@texample.com
      author_name: octocat-bot
      message: "update pages"
      branch: gh-pages
      pages_directory: docs/
      netrc_password: ghp_randomstring

Build

Build the binary with the following command:

make build

Build the Container image with the following command:

docker build --file Containerfile.multiarch --tag thegeeklab/wp-git-action .

Test

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