Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #194

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #194

wants to merge 1 commit into from

Conversation

cykyy
Copy link

@cykyy cykyy commented Aug 14, 2020

To release a new version of a plugin, we suggest the following checklist. Checking these locally before pushing to the repository gives you immediate feedback, instead of waiting for the repository to automatically run the checks.

  • update the information.version in manifest.json; please use semantic versioning ("major.minor.patch", e.g. "1.4.2" - major can break compatibility, minor can introduce compatible new features, patch is for bug fixes)
  • in the project root directory, run bash php-cs-check.sh to check for valid PHP code
    • normally, this should report no errors
    • if any found, please fix - these could prevent your plugin from working
  • in the plugins/ directory, run php ../pack-plugin.php $YOUR_PLUGIN, where $YOUR_PLUGIN is the directory name of your plugin; this creates the installable package
    • if you have a composer.json, this will check it and install the dependencies - if this reports as "outdated", please fix by running composer update in your plugin's directory
    • normally, this should finish without errors or warnings
  • in the project root directory, run php validate.php
    • normally, this should report 0 errors
    • if it complains that plugins.json is outdated, run php generate-json.php > plugins.json to update it.
  • commit the changes made during these steps

@cykyy
Copy link
Author

cykyy commented Aug 21, 2020

:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants