mirror of
https://github.com/thegeeklab/wp-git-action.git
synced 2024-11-24 22:50:39 +00:00
92 lines
2.7 KiB
Markdown
92 lines
2.7 KiB
Markdown
---
|
|
title: wp-git-action
|
|
---
|
|
|
|
[](https://ci.thegeeklab.de/repos/thegeeklab/wp-git-action)
|
|
[](https://hub.docker.com/r/thegeeklab/wp-git-action)
|
|
[](https://quay.io/repository/thegeeklab/wp-git-action)
|
|
[](https://goreportcard.com/report/github.com/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 perform git actions.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Usage
|
|
|
|
```YAML
|
|
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
|
|
|
|
<!-- 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
|
|
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:
|
|
|
|
```Shell
|
|
make build
|
|
```
|
|
|
|
Build the Container image with the following command:
|
|
|
|
```Shell
|
|
docker build --file Containerfile.multiarch --tag thegeeklab/wp-git-action .
|
|
```
|
|
|
|
## Test
|
|
|
|
```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
|
|
```
|