Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.28 KB

RELEASING.md

File metadata and controls

37 lines (22 loc) · 1.28 KB

Here’s how to release a new version of the election websites theme.

Version numbering

The election website template should use Semantic Versioning.

Update the version number

Update the following files with the new version number:

  • style.css
  • functions.php
  • package.json
  • package-lock.json

Update the changelog

Update the changelog in README.md. Describe the changes in a few bullet points. Use language understandable by election officials, not software engineers.

Update .gitattributes

If you have added configuration or intermediate build files that should not be included in the release, add them to .gitattributes.

Update the master branch

Ensure all changes are pushed and merged to master.

Create a release on GitHub

  • Draft a new release
  • Enter the version number into tag version (i.e. 1.0.2). Do not include v in the tag name, i.e. not v1.0.1.
  • Copy and paste the bullet points from the changelog in the “Describe this release” field.
  • Click Publish release

Verify the release

Check the values returned from the GitHub release API and confirm the version number is correct.