Skip to content
This repository was archived by the owner on Oct 4, 2019. It is now read-only.

Commit b90bebf

Browse files
author
Justin Shreve
authored
Add notes about creating a new release to our README
1 parent 1d0cf96 commit b90bebf

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,16 @@ Please read the [WooCommerce contributor guidelines](https://github.com/woocomme
1212
Endpoints are located in the `api/` folder. Endpoints inherit from the stable version of the endpoint. If you need to change the behavior of an endpoint, you can do so in these classes. You can also introduce new endpoints by adding them to the root plugin file [wc-api-dev.php](https://github.com/woocommerce/wc-api-dev/blob/master/wc-api-dev.php) (mirrors core's [class-wc-api.php](https://github.com/woocommerce/woocommerce/blob/master/includes/class-wc-api.php)).
1313

1414
phpunit tests for the API are located in the `tests/unit-tests/` folder and are also merged and shipped with WooCommerce core. You can use the same helpers/framework files that core uses, or introduce new ones.
15+
16+
## Creating a new release
17+
18+
When changes are ready to be released to the world properly, use the GitHub release manager. Please note that since version `0.6.0`, the plugin has the capability of auto-updating -- please make sure changes have been properly tested. You can still merge into master and create pre-releases, but creating a "public" release will cause sites to up date.
19+
20+
When creating a public release, do the following:
21+
22+
* Add a changelog and bump the version in `readme.txt`.
23+
* Bump the version in the plugin header.
24+
* The tag & name of the release should both match the new version number.
25+
* Post your changelog notes in the description of the release.
26+
* Create & attach a binary containing a zip for the latest plugin version. The binary name should be `wc-api-dev.zip`. Please double check that the folder inside the archive is also called `wc-api-dev` and not something like `wc-api-dev-###hash` or `wc-api-dev-master`. You can create this binary by downloading a zip from GitHub, unzipping, and renaming the folder.
27+
* Publish your release.

0 commit comments

Comments
 (0)