Release versioned software and produce release notes
I wish the song "It's a Sin" was about releasing unversioned and undocumented software, but alas, it is not.
Each release should be uniquely versioned. We should also keep release notes, but it's one of those things that can be easy to miss.
...I really wish this was something more enterprise teams did, but I find it to be less common than in the open-source or product development communities. It kind of makes sense, but this needn't be the case.
So, how do we make it easy "to do the right thing"? We'll add a tool to help us!
🎯 Example: Instead of writing manual release notes, we use Standard Version to output them for us from our commits into the
CHANGELOG.mdfile. Practically, this works simply by running
npm run release.
The standard convention we want to use is called semantic versioning, which is the format you've probably seen a million times with versions like
MAJOR.MINOR.PATCHin the version number. Using this tool you get that automatically. For a Node project like the one we are using, you could simply update the number in
package.jsonand then regenerate any files (
npm run buildor similar and build the docs) and you're all set prior to publishing on NPM or similar package libraries.
This should be easy and powerful enough to help set an example in this area.