Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varunsridharan/action-wp-org-deploy
Github Action To Publish WordPress.org Plugin's Update
https://github.com/varunsridharan/action-wp-org-deploy
action-wordpress beta customizable deployment push release release-automation secrets tidio vs-github-action wordpress wordpress-deployment wordpress-development wordpress-plugin wordpress-theme workflow wp wp-developers wp-plugin wp-theme
Last synced: 4 months ago
JSON representation
Github Action To Publish WordPress.org Plugin's Update
- Host: GitHub
- URL: https://github.com/varunsridharan/action-wp-org-deploy
- Owner: varunsridharan
- License: mit
- Created: 2019-08-24T11:52:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-09-30T02:42:02.000Z (over 4 years ago)
- Last Synced: 2024-09-27T14:42:18.219Z (4 months ago)
- Topics: action-wordpress, beta, customizable, deployment, push, release, release-automation, secrets, tidio, vs-github-action, wordpress, wordpress-deployment, wordpress-development, wordpress-plugin, wordpress-theme, workflow, wp, wp-developers, wp-plugin, wp-theme
- Language: Shell
- Homepage: https://github.com/marketplace/actions/wordpress-org-deploy
- Size: 59.6 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress.org Plugin Deploy - ***Github Action***
This Action commits the contents of your Git tag to the WordPress.org plugin repository using the same tag name.
It excludes Git-specific items or files and directories as optionally defined in your `.wporgignore` file, and
moves anything from a `.wordpress-org` subdirectory to the top-level `assets` directory in Subversion (plugin banners, icons, and screenshots).
## Configuration
### Required secrets
* `WORDPRESS_USERNAME`
* `WORDPRESS_PASSWORD`
* `GITHUB_TOKEN` - you do not need to generate one but you do have to explicitly make it available to the Action
Secrets can be set while editing your workflow or in the repository settings. They cannot be viewed once stored. [GitHub secrets documentation](https://developer.github.com/actions/creating-workflows/storing-secrets/)
### Optional environment variables
* `SLUG` - defaults to the respository name, customizable in case your WordPress repository has a different slug. This should be a very rare case as WordPress assumes that the directory and initial plugin file have the same slug.
* `VERSION` - defaults to the tag name; do not recommend setting this except for testing purposes
* `ASSETS_DIR` - defaults to `.wordpress-org`, customizable for other locations of WordPress.org plugin repository-specific assets that belong in the top-level `assets` directory (the one on the same level as `trunk`)
* `IGNORE_FILE` - defaults to `.wporgignore`, customizable for other locations of list of files to be ignore like `.gitignore`
* `ASSETS_IGNORE_FILE` - defaults to `.wporgassetsignore`, customizable for other locations of list of files to be ignore like `.gitignore`
* `DIST_LOCATION` - defaults to `./dist/`, option to save final zip files.
### Excluding files from deployment
If there are files or directories to be excluded from deployment, such as tests or editor config files, they can be specified in your `.wporgignore` file. If you use this method, please be sure to include the following items:
```gitignore
# Directories
.wordpress-org
.github
# Files
/.gitattributes
/.gitignore
```
> **⚠️ Note:** You Should Provide Github Token. If Not No Updated File Will Be Committed & Pushed
## Example Workflow File
```yaml
name: Deploy to WordPress.org
on:
push:
branches:
- refs/tags/*
jobs:
tag:
name: New tag
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: WordPress Plugin Deploy
uses: varunsridharan/action-wp-org-deploy@master
with:
WORDPRESS_PASSWORD: ${{ secrets.WORDPRESS_PASSWORD }}
WORDPRESS_USERNAME: ${{ secrets.WORDPRESS_USERNAME }}
SLUG: my-super-cool-plugin
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Credits
This Github Action Bootstrapped From
* [10up/action-wordpress-plugin-deploy](https://github.com/10up/action-wordpress-plugin-deploy)
* [rtCamp/action-wordpress-org-plugin-deploy](https://github.com/10up/rtCamp/action-wordpress-org-plugin-deploy)
---
## Change Log
### 1.3 - 29/04/2020
* Added Custom Arg To Provide Path To Save Dist File.
### 1.2 - 29/04/2020
* Improved Logging
### 1.1 - 06/09/2019
* Added Option To Exclude Files When Updating Assets Folder.
### 1.0 - 24/08/2019
* First Release
## Contribute
If you would like to help, please take a look at the list of
[issues][issues] or the [To Do](#-todo) checklist.
## License
Our GitHub Actions are available for use and remix under the MIT license.
## Copyright
2017 - 2018 Varun Sridharan, [varunsridharan.in][website]
If you find it useful, let me know :wink:
You can contact me on [Twitter][twitter] or through my [email][email].
## Backed By
| [![DigitalOcean][do-image]][do-ref] | [![JetBrains][jb-image]][jb-ref] | [![Tidio Chat][tidio-image]][tidio-ref] |
| --- | --- | --- |
[twitter]: https://twitter.com/varunsridharan2
[email]: mailto:[email protected]
[website]: https://varunsridharan.in
[issues]: issues/
[do-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/DO_Logo_Horizontal_Blue-small.png
[jb-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/phpstorm-small.png?v3
[tidio-image]: https://vsp.ams3.cdn.digitaloceanspaces.com/cdn/tidiochat-small.png
[do-ref]: https://s.svarun.in/Ef
[jb-ref]: https://www.jetbrains.com
[tidio-ref]: https://tidiochat.com