mirror of
https://github.com/thegeeklab/wp-git-action.git
synced 2024-11-22 20:20:38 +00:00
90 lines
2.4 KiB
Markdown
90 lines
2.4 KiB
Markdown
|
---
|
||
|
|
title: wp-git-action
|
||
|
|
---
|
||
|
|
|
||
|
|
[](https://wp.thegeeklab.de/thegeeklab/wp-git-action)
|
||
|
|
[](https://hub.docker.com/r/thegeeklab/wp-git-action)
|
||
|
|
[](https://quay.io/repository/thegeeklab/wp-git-action)
|
||
|
|
[](https://github.com/thegeeklab/wp-git-action/graphs/contributors)
|
||
|
|
[](https://github.com/thegeeklab/wp-git-action)
|
||
|
|
[](https://github.com/thegeeklab/wp-git-action/blob/main/LICENSE)
|
||
|
|
|
||
|
|
Woodpecker CI plugin to execute git actions.
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
<!-- spellchecker-disable -->
|
||
|
|
{{< toc >}}
|
||
|
|
<!-- spellchecker-enable -->
|
||
|
|
<!-- prettier-ignore-end -->
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```YAML
|
||
|
|
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
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
<!-- spellchecker-disable -->
|
||
|
|
{{< propertylist name=wp-git-action.data sort=name >}}
|
||
|
|
<!-- spellchecker-enable -->
|
||
|
|
<!-- prettier-ignore-end -->
|
||
|
|
|
||
|
|
### 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.
|
||
|
|
|
||
|
|
```YAML
|
||
|
|
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:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
make build
|
||
|
|
```
|
||
|
|
|
||
|
|
Build the Container image with the following command:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
docker build --file Containerfile.multiarch --tag thegeeklab/wp-git-action .
|
||
|
|
```
|
||
|
|
|
||
|
|
## Test
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
|
||
|
|
```
|