Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yukihiko-shinoda/action-deploy-wordpress-plugin
GitHub Action for deploy WordPress plugin into SubVersion repository on WordPress.org.
https://github.com/yukihiko-shinoda/action-deploy-wordpress-plugin
deploy deployment deployment-automation docker dockerfile github-actions wordpress-plugin wp-plugin
Last synced: 23 days ago
JSON representation
GitHub Action for deploy WordPress plugin into SubVersion repository on WordPress.org.
- Host: GitHub
- URL: https://github.com/yukihiko-shinoda/action-deploy-wordpress-plugin
- Owner: yukihiko-shinoda
- Created: 2019-12-04T16:01:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T14:35:01.000Z (9 months ago)
- Last Synced: 2024-11-09T20:05:04.272Z (about 2 months ago)
- Topics: deploy, deployment, deployment-automation, docker, dockerfile, github-actions, wordpress-plugin, wp-plugin
- Language: Shell
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Deploy WordPress plugin
[](https://github.com/yukihiko-shinoda/action-deploy-wordpress-plugin/actions?query=workflow%3ATest)
[](https://hub.docker.com/r/futureys/deploy-wordpress-plugin/builds)
[](https://hub.docker.com/r/futureys/deploy-wordpress-plugin/builds)
[](https://hub.docker.com/r/futureys/deploy-wordpress-plugin/dockerfile)
[](http://twitter.com/share?text=Deploy%20WordPress%20plugin&url=https://github.com/marketplace/actions/deploy-wordpress-plugin&hashtags=wordpress)
This is deployment action for WordPress Plugin from Git repository to SubVersion on WordPress.org.
## requirement
Your WordPress Plugin project can accept that:
- Tag revision on Git repository before deploy into WordPress.org
- Tag name of revision on source Git repository to deploy is the same as version number of plugin’s main PHP file on tagged revision of source Git repository
## out of scope
- Deploying old version than latest version
- [Deploying Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
(Even if Git repository includes assets, this project will deploy
the revision content as it is under trunk and tags
of SubVersion repository on WordPress.org.)
## excluding strategy
The process executes rsync from Git working tree to SubVersion working tree with ```.rsync-filter```.
### default behavior
rsync will read [default .rsync-filter file](https://github.com/yukihiko-shinoda/dockerfile-deploy-wordpress-plugin/blob/master/runner/project/roles/rsync_git_to_svn/templates/.rsync-filter.j2).
### customizing behavior
If ```.rsync-filter``` file is exist on the root of Git working tree, rsync will read it. The most primitive how to write it is to list up files and directories you want to exclude. For more details, following contents will be helpful.
- [linux - Using Rsync filter to include/exclude files - Stack Overflow](https://stackoverflow.com/questions/35364075/using-rsync-filter-to-include-exclude-files)
- [rsync(1) - Linux man page](https://linux.die.net/man/1/rsync)
## Usage
The code example is given first and some key points are explained later.
Ex:
```yaml
name: Deploy WordPress plugin
on:
push:
# 1. Trigger by pushing tag
tags:
- '[0-9]+.[0-9]+.[0-9]+'
jobs:
build:
name: Deploy WordPress plugin
# 2. Specify Linux runner
runs-on: ubuntu-20.04
steps:
# 3. Checkout before Use this deployment action
- name: Checkout
uses: actions/checkout@v3
# 4. Use action with environment variable set by secrets
- name: Deploy
uses: yukihiko-shinoda/action-deploy-wordpress-plugin@v2
env:
SVN_REPOSITORY_URL: ${{ secrets.SvnRepositoryUrl }}
SVN_USER_NAME: ${{ secrets.SvnUserName }}
SVN_USER_PASSWORD: ${{ secrets.SvnUserPassword }}
```
### key point
#### 1. Trigger by pushing tag
If you prefer, you can use [filter pattern](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).
#### 2. Specify Linux runner
We recommend Linux runner. Windows and Mac also may use this action,
however we are not running test on these environment to save testing cost now.
#### 3. Checkout before Use this deployment action
This deployment action assumes that the Git repository has been checked out.
#### 4. Use action with environment variable set by secrets
In this example, environment variables are [presented by secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets). At least, you'd better to use secret for ```SVN_USER_NAME``` and ```SVN_USER_PASSWORD```.