0
0
mirror of https://github.com/thegeeklab/wp-git-action.git synced 2024-11-14 09:00:42 +00:00
wp-git-action/_docs/content/_index.md

2.5 KiB

title
wp-git-action

Build Status Docker Hub Quay.io Go Report Card GitHub contributors Source: GitHub License: MIT

Woodpecker CI plugin to perform git actions.

{{< toc >}}

Usage

kind: pipeline
name: default

steps:
  - name: commit changelog
    image: thegeeklab/wp-git-action
    settings:
      action:
        - commit
        - push
      netrc_password: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM
      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.

kind: pipeline
name: default

steps:
  - name: publish
    image: thegeeklab/wp-git-action
    settings:
      action:
        - pages
      author_email: bot@thegeeklab.de
      author_name: thegeeklab-bot
      message: "update pages"
      branch: gh-pages
      pages_directory: docs/
      netrc_password: ghp_3LbMg9Kncpdkhjp3bh3dMnKNXLjVMTsXk4sM

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