GitHub Action
WordPress Org Deploy
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).
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
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 purposesASSETS_DIR
- defaults to.wordpress-org
, customizable for other locations of WordPress.org plugin repository-specific assets that belong in the top-levelassets
directory (the one on the same level astrunk
)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.
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:
# Directories
.wordpress-org
.github
# Files
/.gitattributes
/.gitignore
⚠️ Note: You Should Provide Github Token. If Not No Updated File Will Be Committed & Pushed
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 }}
This Github Action Bootstrapped From
- Added Custom Arg To Provide Path To Save Dist File.
- Improved Logging
- Added Option To Exclude Files When Updating Assets Folder.
- First Release
If you would like to help, please take a look at the list of issues or the To Do checklist.
Our GitHub Actions are available for use and remix under the MIT license.
2017 - 2018 Varun Sridharan, varunsridharan.in
If you find it useful, let me know 😉
You can contact me on Twitter or through my email.