This document describes the workflow for deploying updates from GitHub to a published package.
Merge the approved Pull Request(s) to the main branch.
An approved Pull Request is when a PR passes all tests and has been approved by one or more reviewers.
Create a New Release, completing the following:
- Choose a tag: Click this button and enter the new version number (e.g.
1.0.1) - Release title: The version number (e.g.
1.0.1) - Describe this release: Enter a bullet point list of changes. A good example and format:
* Added: API Class: `get_products()` function.
* Fix: API Class: Return array instead of WP_Error when no resources exist.
When you're happy with the above, click Publish Release.
To use the published release in ConvertKit Plugins, in the ConvertKit Plugin edit the composer.json file to use the tagged version:
"require": {
"convertkit/convertkit-wordpress-libraries": "1.0.1"
},
The specific version number tells Composer that we want to use a specific tag of this repository in our ConvertKit Plugin. Read more.