Build & Release

Prerequisites and Reading

GitFlow

We use the GitFlow branching model. Check out the Pb0Spc-cM-p2 if you haven't already.

Woorelease

woorelease is used to deploy to WooCommerce.com: https://github.com/woocommerce/woorelease

⚠ IMPORTANT Some Woorelease pre-configuration is necessary:

• Download the woorelease.zip from the latest release, then unzip the archive and install the woorelease.phar to use locally.
• https://github.com/woocommerce/woorelease/wiki/Prerequisites
  • Retrieve the Ventures WooCommerce.com API Keys (Secret store → "Team Ventures – WooCommerce.com").
  • Generate your own GitHub API Keys.
  • Ensure you have your SSH keys added to GitHub, as Woorelease uses SSH to clone repos.

SVN

Ensure you have svn installed on your system by running which svn. For macOS, svn can be installed (if missing) using brew install svn.

SVN requires the following to be present in the ~/.subversion/servers file:

[groups]
wporgplugins = plugins.svn.wordpress.org
 
[wporgplugins]
username = woocommerce
store-passwords = no

You will likely need to have the woocommerce WordPress.org password on hand for your first release.

Release basics

We use GitHub workflow to automate the process. You will still need to use woorelease locally and do a few steps manually in GitHub.

1. Go to Actions > Prepare New Release.

2. Open the "Run workflow" dropdown, fill in the details, and click "Run workflow" button.

3. Wait for the new release PR to be created by the github-actions[bot].

4. Follow the steps from the new PR.