Following today's v5 release, we saw a few points of improvement on our release process:
The API docs include the current version number; docs are now updated as part of the version script.
Two tests use a hard-coded version of the project. There's not much value added by doing that, and it's annoying to maintain, so I changed them to use the version file.
a. The version file is also something we've considered removing, but in the meantime I've added a test to make sure that the file just exports a valid semver string.
Added a GitHub Actions workflow to publish to npm, triggered by creating a GitHub release.
The new release process is:
Check out code to release
npm version <type>, using major/minor/etc. as appropriate
git push && git push tags/<version>
Create GitHub release
🎉 it's on npm!
Important: Publishing will require creating/storing an NPM_TOKEN secret. So gotta do that before this will actually work.
This PR also contains a few prettier fixes because that happens sometimes.
Following today's v5 release, we saw a few points of improvement on our release process:
versionscript.The new release process is:
npm version <type>, using major/minor/etc. as appropriategit push && git push tags/<version>Important: Publishing will require creating/storing an
NPM_TOKENsecret. So gotta do that before this will actually work.This PR also contains a few prettier fixes because that happens sometimes.