release-me.sh
Script that hopefully help in managing and shipping WordPress plugin releases on GitHub and SVN.
Get started with ./release-me.sh
Release branch management
This script is designed to help keep your release branches stay in order. Typically used to kick off a code freeze and start the beta cycle.
Options
| Options | Description |
|---|---|
-h or --help
|
Shows help message |
-v or --version
|
Shows script version |
-n or --new
|
Start a new release branch |
-u or --update
|
Update existing release branch |
-r or --release
|
The release number you are branching |
-p or --plugin-slug
|
Plugin's slug |
-o or --github-org
|
GitHub organization (default "Automattic") |
-b or --branch
|
Build branch source (default master) |
-c or --clean
|
Clean build directory |
Customize the build.
This script will always respect the custom variables set in .custom above anything in the target plugin.
.releaseignore: A txt file that comprises of lines of file patterns to exclude from production release branches. Add file patterns to purge extra things from the release branch that is not defined in the plugin's .releaseignore.
- This will be concatenated with the plugin's
.releaseignoreand/or.svnignorefile if they are found.
.custom: A file containing many over-writable aspects of of the script, such as:
-
BUILD_COMMAND: A string to beeval'd during the script that will "build" the plugin. It defaults toyarn build-production.
Example commands
Kick off a new beta release!
./release-me.sh -n
Create a new set of release branches for version 2.1.
./release-me.sh -n -o="Automattic" -p="vaultpress" -r="2.1"
Update the 2.2 release branch based on the branch hotfix-branch
./release-me.sh -u -b="hotfix-branch" -r="2.2"