Skip to content

Workflow for Plugin Release

Jump to bottom
Shreyas Ikhar edited this page Oct 19, 2022 · 3 revisions

Workflow for Plugin Release

Assuming the new version to be release is version 2.0

Pre-Release

  1. Ensure the new version is correctly mentioned in readme.txt , README.md and plugin-main-file.php
  2. Ensure the new functionality/bug fixes are added in the Changelog section of readme.txt
  3. Ensure all plugin contributors are properly listed in readme.txt and README.md. Eg. New developers are working on the plugin, so their WordPress usernames need to be added in Contributors section of readme.txt and README.md
  4. Ensure any new functionality that is added is compliant with the minimum WordPress version the plugin requires that is specified as Requires at least in readme.txt
  5. Ensure to modify the Tested up to WordPress version in readme.txt based on the latest WordPress version
  6. Ensure the code works correctly with the PHP version as specified in Requires PHP of the readme.txt file.
  7. Ensure the version number in package.json and package-lock.json is same as the new version of plugin. npm version 2.0.0
  8. Ensure the version number in .po file is same as the new version of plugin and copyright year is updated with the current year. npm run language
  9. If the repo requires the vendor directory to be committed in the repo, ensure to update those packages and test with latest packages before release. composer update
  10. If the repo requires the build directory to be committed in the repo, ensure to build the assets prior to release. npm run prod
  11. A final test of the plugin should be done in completely new installations of WordPress with both the latest version of WordPress and the minimum version of WordPress supported by the plugin with error logs enabled and see if there’s any errors being thrown by our plugin.

Release

  1. Create a Git tag locally for the new version of the plugin once all pre-release checkpoints are met. git tag 2.0
  2. Ensure the tag was correctly created by going through the output of following command: git tag
  3. Push the new tag to the plugin’s GitHub repo git push origin 2.0
  4. Wait for GitHub action to complete and release the plugin on [WordPress.org](http://WordPress.org) You can check the status of the GitHub action by going through the Actions tab in the GitHub repo https://github.com/{repo}/actions

Post-Release

Once the plugin is released, there are a few things that need to be checked.

  1. Check if the new version number pushed is added correctly as tags in the SVN repo
  2. Check if new contributors are being displayed correctly
  3. Check if build directory assets are correctly sent to the SVN repo
  4. Check if the vendor directly has been correctly added to the SVN repo
  5. From within a new installation of WordPress, try to install the plugin directly via searching the name of the plugin in the Add New plugin page in WordPress Dashboard.
  6. Go through the error logs for any errors.
Clone this wiki locally