Release and Update

Branches and Versioning

  • master branch is the stable branch and the version number is in the format x.y.z
    • for example, 0.15.0
  • develop branch is the development branch and the version number is in the format x.y.z-betaN
    • for example, 0.16.0-beta1

Versions are defined in findstr.php file, following the format x.y.z or x.y.z-betaN, where N is the beta number. Hotfixes are made in the master branch, version number is incremented by 0.0.1.

How to make a release

  • Update the changelog in changelog.md
  • Update the version in findstr.php
  • Commit and push the changes, merge to master branch

Pre-Release

Every merge to develop branch will trigger a pre-release if the version is modified in findstr.php.

Don't forget to update the changelog in changelog.md and the version in findstr.php.

The pre-release will be available in the GitHub release page, and in the plugin if updated channel is set to beta.

Update

Plugin support update in WordPress admin panel, based on GitHub release. There is a manual GitHub action to make the release. The action will zip the plugin and upload it to the release page, then merge the release branch to master branch.