search

silverstripe / cwp

Common Web Platform (CWP) features module. We strongly recommend using it for all new CWP projects. Future features will be delivered here.
https://www.cwp.govt.nz
BSD 3-Clause "New" or "Revised" License
10 stars 26 forks source link

Create a release template #188

Closed brynwhyman closed 5 years ago

brynwhyman commented 5 years ago

Overview While the actual change log is generated during the release process, there's no clear template for what other information should be included in the release notes on CWP.govt.nz. This leads to inconsistent information being provided between releases. See 2.1.0 vs. 2.2.2.

Suggested changes A new template should be created that includes the following headings. These could be added to or removed depending on what's contained in the release.

How to generate the template To ensure this is easy to slid into the existing process the template should be easy to access and edit. Having it automatically created as part of the release process would be ideal.

robbieaverill commented 5 years ago

Cow enhancement issue: https://github.com/silverstripe/cow/issues/138

brynwhyman commented 5 years ago

Related to 'Known issues', we could add reference to our GitHub issue search client, something like:

"You can also use the SilverStripe bug tracker to review all open high or critical impact bugs"

Cheddam commented 5 years ago

Cow enhancement PR: https://github.com/silverstripe/cow/pull/140

Cheddam commented 5 years ago

Cow enhancement has been merged, PR for implementing the template in Kitchen Sink: https://github.com/silverstripe/cwp-recipe-kitchen-sink/pull/37

robbieaverill commented 5 years ago

All merged

brynwhyman commented 5 years ago

Reopening because the template wasn't updated in: https://github.com/silverstripe/cwp-recipe-kitchen-sink/blob/master/.changelog.md.twig

brynwhyman commented 5 years ago

Closed with https://github.com/silverstripe/cwp-recipe-kitchen-sink/issues/40