How to release a version

Documentation of useful steps for creating a release

Review / Update CHANGELOG

• Compare master with the last version released. If there are commits missing from the CHANGELOG, add high-level descriptions
• Make a PR for bumping the CHANGELOG version (i.e. Unreleased section should now have a version number and a release date)
• Get a team member to review and merge your PR.

Create release tag and notes

• Once master contains the to-be-released software with an updated changelog, create the release + tag in GitHub.
• Add notes to release
  • One sentence description of any major changes
  • Anchored link to CHANGELOG
  • Link to diff list

Example

v1.20.0 adds Chinese Spotlight locale files, a minor post-Shibboleth adjustment, and update dependencies.

Full changelog

https://github.com/sul-dlss/exhibits/compare/v1.19.1...v1.20.0

---

Note: hit edit and copy markdown above for special GitHub formatting!

Deployment

• Communicate with service owner and dev team about incoming deployments (#dlss-spotlight-dev). Note that indexing jobs will temporarily be paused (10 - 20 minutes).
• Deploy to stage. Confirm deployment, check Honeybadger errors.
• Deploy to prod. Confirm deployment, check Honeybadger errors.