Creating a Release

Creating a release

1. Update the Version number in disciple-tools-plugin-starter-template.php
2. 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.

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

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

2. 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

1. Update version number in [*plugin-name*].php and commit changes to Github.
   • In the comment at the top
2. Download master [.zip] from the plugin Github repo, rename .zip to disciple-tools-[*plugin-name*].zip
3. Unzip the .zip file
4. Rename [*plugin-name*]-master to [*plugin-name*] removing -master
5. Re-zip the file
6. Create a new release in GitHub with the new version number (eg: 1.3.1) and release description.
7. Attach the plugin .zip file to the new version release.

Making it available to others

1. Update your published release description with what changed
2. update the version-control.json

• version line
• last_updated line
• make sure the other lines are correct and point to your repository