Skip to content

Home

Jump to bottom
Parvez Akther edited this page Mar 12, 2024 · 5 revisions

Welcome to the developer guide for the official WordPress plugin that connects ThriveDesk with WordPress. This guide provides details on building and releasing the plugin to wp.org.

Deploy plugin to WordPress.org

This plugin utilizes the Plugin Deploy Action to automate deployment on WP.org. Here's the process:

  1. Develop new features or fix bugs on separate branches (feat/FEATURE or bugfix/issue).
  2. When ready, merge the changes to the develop branch.
  3. Tag the release from the develop branch to trigger automatic deployment to WP.org.

Release versioning

To ensure a smooth release process, follow these steps:

  • Update the Stable Tag variable in the readme.txt file.
  • In thrivedesk.php, synchronize the Version: and public $version to the same version number.

Important

Ensure consistency by using the same version number across all variables. The tag should match the version number in the mentioned files.

Update readme file

Include a clear and descriptive changelog in the changelog section at the bottom of the readme.txt file. Keep it human-readable and easy to understand.

❌ Don't

Fix: Revert pro plan
Update: Routing update

✅ Do

Fix: Accidentally removed pro plan support for WPPortal and added it again.
Update: Updated routing class to avoid conflict with WooCommerce/EDD

Versioning guide

We follow Semantic versioning for our product with a little twist.

Since this is a smaller plugin receiving regular updates, we primarily use the Two Digit format for releases. The third digit is only used for immediate patches caused by the second digit. For example, if release 1.1 breaks something and an immediate patch is needed, release 1.1.1.

Optional

Tested up to - Always test the plugin with the latest WordPress version before release. Update the Tested up to variable in both the readme.txt and thrivedesk.php files.

Plugin Readme/Assets Update

Ensure that the plugin readme and assets are up-to-date:

  • ASSETS_DIR - Defaults to .wordpress-org. Replace existing files with new ones.
  • Readme - Defaults to readme.txt. Update all content here.

Important

This branch is exclusively reserved for changes to the .wordpress-org directory and the readme.txt file. Any modifications to other files must be removed before committing. Failure to comply will result in a failed deployment on wp.org.

We use 10up wordpress plugin readme/asset update action for this.

Push changes to the master branch, and assets will automatically be updated on WP.org. Remember to update the master branch with changes from the develop branch first.

Integrations

Clone this wiki locally