Pepperminty-Wiki/docs/99-Making-A-Release.md

# Making a Release
This page contains a few notes about making a release of Pepperminty Wiki. These notes are intended to remind me of things I need to do, but you may find them useful.

The following things need to be done to prepare for a release:

 - Check for outstanding issues
 - Check the changelog
 - Make sure that the README is up to date
 - Make sure that Pepperminty Wiki actually works
 - Make sure that the [downloader actually works](https://github.com/sbrl/Pepperminty-Wiki/releases/tag/v0.19.1-hotfix1)
 - Bump the version:
	 - In the `version` file
	 - In the changelog
	 - In `apidoc.json` (TODO: Automate this?)
     - In `package.json` (TODO: Automate this?)
 - (Stable releases only):
     - Pull down changes to update [online downloader](https://starbeamrainbowlabs.com/labs/peppermint/download.php)
     - Ensure docs are up-to-date
 - Update wikimatrix
 - Generate the hashes & signature (see the `sign` build action)
 - Write & publish the release

## Release text template
The following template text can be used for releases:

```markdown
INTRODUCTION_HERE

(DELETE_IF_APPROPRIATE)
Note that this is a maintenance release that backports some urgent bugfixes to LATEST_STABLE_VERSION. Current development efforts are focused on NEXT_VERSION. The work-in-progress changelog for NEXT_VERSION can be found [here](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md).

Have you updated to this release? [Click this link to say hi](https://starbeamrainbowlabs.com/blog/viewtracker.php?action=record&format=text&post-id=pepperminty-wiki/PEPPERMINTY_WIKI_VERSION)!

This release also has an experimental GPG and SHA256 hashes file attached. My GPG key is `C2F7843F9ADF9FEE264ACB9CC1C6C0BB001E1725` - please [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/) if you encounter any issues :slightly_smiling_face:

## Updating
You can update to this release simply by grabbing an updated copy of `index.php` and replacing the version in your current wiki (don't forget to take backups! I make every effort to squash as many bugs as possible, but you can never be too certain). You can get an updated copy of `index.php` in a number of ways:

 - By downloading the `index.php` file attached to this release
 - Using the [online downloader](https://starbeamrainbowlabs.com/labs/peppermint/download.php) (always has the latest stable version)
 - Using the online downloader offline
 - Building your own from source

For more information on the last 2 methods, please see [the documentation](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/05-Getting-A-Copy.html) for more information.

For those who want to contribute financially as a thank you, I've recently [setup a Liberapay](https://liberapay.com/sbrl) to accept donations. It's certainly not required, but would definitely help me out :-) If you want to contribute but Liberapay isn't for you, please let me know (e.g. open an issue, see [my website for more contact options](https://starbeamrainbowlabs.com/))

## Since VERSION_NUMBER_HERE
FULL_CHANGELOG_HERE
```
Seriously reorganise stuff. Much tidier :D 2018-12-12 23:23:50 +00:00			`# Making a Release`
			`This page contains a few notes about making a release of Pepperminty Wiki. These notes are intended to remind me of things I need to do, but you may find them useful.`
Add development notes 2016-07-05 14:53:13 +00:00
			`The following things need to be done to prepare for a release:`

			`- Check for outstanding issues`
			`- Check the changelog`
			`- Make sure that the README is up to date`
			`- Make sure that Pepperminty Wiki actually works`
Bump version for first beta release :D 2019-11-19 21:23:39 +00:00			`- Make sure that the [downloader actually works](https://github.com/sbrl/Pepperminty-Wiki/releases/tag/v0.19.1-hotfix1)`
Seriously reorganise stuff. Much tidier :D 2018-12-12 23:23:50 +00:00			`- Bump the version:`
			- In the `version` file
			`- In the changelog`
			- In `apidoc.json` (TODO: Automate this?)
Update making a release checklist 2019-08-28 23:39:41 +00:00			- In `package.json` (TODO: Automate this?)
Small typos 2019-09-20 10:24:12 +00:00			`- (Stable releases only):`
Update release checklist 2019-01-05 22:28:30 +00:00			`- Pull down changes to update [online downloader](https://starbeamrainbowlabs.com/labs/peppermint/download.php)`
			`- Ensure docs are up-to-date`
Update release checklist 2018-05-05 20:55:48 +00:00			`- Update wikimatrix`
Add build action to sign releases 2020-07-10 19:16:17 +00:00			- Generate the hashes & signature (see the `sign` build action)
Add development notes 2016-07-05 14:53:13 +00:00			`- Write & publish the release`
(finally) remove module_index.json from git 2020-01-16 18:59:35 +00:00
			`## Release text template`
			`The following template text can be used for releases:`

			```markdown
			`INTRODUCTION_HERE`

Update release text template 2020-01-16 19:10:43 +00:00			`(DELETE_IF_APPROPRIATE)`
(finally) remove module_index.json from git 2020-01-16 18:59:35 +00:00			`Note that this is a maintenance release that backports some urgent bugfixes to LATEST_STABLE_VERSION. Current development efforts are focused on NEXT_VERSION. The work-in-progress changelog for NEXT_VERSION can be found [here](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md).`

Tweak release template text 2020-02-03 23:00:53 +00:00			`Have you updated to this release? [Click this link to say hi](https://starbeamrainbowlabs.com/blog/viewtracker.php?action=record&format=text&post-id=pepperminty-wiki/PEPPERMINTY_WIKI_VERSION)!`

improve documentation in verifying downloaded releases 2020-07-10 19:44:14 +00:00			This release also has an experimental GPG and SHA256 hashes file attached. My GPG key is `C2F7843F9ADF9FEE264ACB9CC1C6C0BB001E1725` - please [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/) if you encounter any issues :slightly_smiling_face:
Add build action to sign releases 2020-07-10 19:16:17 +00:00
(finally) remove module_index.json from git 2020-01-16 18:59:35 +00:00			`## Updating`
			You can update to this release simply by grabbing an updated copy of `index.php` and replacing the version in your current wiki (don't forget to take backups! I make every effort to squash as many bugs as possible, but you can never be too certain). You can get an updated copy of `index.php` in a number of ways:

			- By downloading the `index.php` file attached to this release
			`- Using the [online downloader](https://starbeamrainbowlabs.com/labs/peppermint/download.php) (always has the latest stable version)`
			`- Using the online downloader offline`
			`- Building your own from source`

			`For more information on the last 2 methods, please see [the documentation](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/05-Getting-A-Copy.html) for more information.`

Fix #209 2020-08-18 12:49:16 +00:00			`For those who want to contribute financially as a thank you, I've recently [setup a Liberapay](https://liberapay.com/sbrl) to accept donations. It's certainly not required, but would definitely help me out :-) If you want to contribute but Liberapay isn't for you, please let me know (e.g. open an issue, see [my website for more contact options](https://starbeamrainbowlabs.com/))`
Add donations text to making a release template text 2020-08-16 23:47:24 +00:00
docs: tweak making a release notes slightly 2020-07-08 23:44:37 +00:00			`## Since VERSION_NUMBER_HERE`
(finally) remove module_index.json from git 2020-01-16 18:59:35 +00:00			`FULL_CHANGELOG_HERE`
			```