Creating a Release

Creating a release

• Update the Version number in disciple-tools-plugin-starter-template.php
• commit your code

Option 1 - Automatic release creation

This option has github actions automatically create a release based on the configuration options in .github/workflows/release.yml. The action waits for a tag to be pushed to the repository and creates a release when one is.

• Check the .github/workflows/release.yml file is updated

  • that disciple-tools-plugin-starter-template is replaced with your plugin's values
  • that line 26 cp -r ... includes all the files you want in your release and remove any folder that were deleted

• When you want to create a release, create a tag with the current version and push the tag:

git tag -a 0.2 -m "0.2"
git push --tags origin master

• github will automatically create a release based on the tag and zip and attach the plugin with only the file you with to include

Option 2 - Manual release creation

• download the .zip file for your plugin from your github repo
• unzip the .zip file
• rename disciple-tools-plugin-starter-template-master to disciple-tools-plugin-starter-template removing -master
• create a release on github
• upload your .zip file

Making it available to others

• Update your published release description with what changed
• update the version-control.json
  • version line
  • last_updated line
  • make sure the other lines are correct and point to your repository