Automated versioning and releases

[slifty]

Discussion

What do you want to talk about?

After we set up #9 we're going to be releasing packages from this repository, which means we should figure out how we want to handle versioning.

Ideally we would automate as much about the release process as possible (without going completely nuts). This will also be useful for other projects (both in TVK and in life), so I'm OK spending a little bit of time on doing it Right.

Relevant Resources / Research

• https://github.com/release-it/release-it#readme (h/t @Laurian)
• https://itnext.io/how-to-automate-versioning-and-publication-of-an-npm-package-233e8757a526

[slifty]

As an interim step, should we build a habit of indicating major / minor / patch as part of a given changelog line?

[slifty]

We've done a few releases now; not automated, but enough to document the process.

So far, we have been releasing packages one at a time (e.g. if 2 packages need to be published, they are done as two separate commits / steps)

0. Build and test the package (yarn build and yarn test from the root directory)

1. Update package.json

• Increment the version according to SEMVER

2. Update the CHANGELOG:

• Create a new section for the new version number
• Move Unreleased change log notes to the new section, minimizing edits but editing as appropriate.
• Add a new diff link.

3. Add a commit (git commit -m "Publish @tvkitchen/package-name@x.y.z")

4. Tag the commit (git tag @tvkitchen/package-name@x.y.z)

5. Push the commit and tag (git push --tags)

6. Sanity check everything on GitHub

7. Publish to npm from the package directory (npm publish)

There is lots of room for error. Also, ideally we would have some kind of beta / pre-release flow as well.