While our release schedule is flexible, our general approach is to release several improvements at the same time rather than to publish small updates frequently and in isolation.
While the versioning and publishing of our primitives is mostly automated via scripts, updates to our documentation website is currently a manual process. We are working to improve this but for now this outline should help contributors with the process.
We track versions during the pull request process. As features are added, modified or improved it's important to keep track of these via versioning.
The easiest way to track changes before raising your PR is to run yarn version check --interactive, this will prompt you to update the semver based on files that have been modified and will store an update file in .yarn/versions/, this is later consumed when publishing new versions. Be sure to check-in these files along with your code changes.
- Checkout latest
main - Run
yarn npm loginand supply your credentials (ensure you have access to the org scope for publishing) - Run
yarn publish - Commit the resulting changes directly to
main(you'll need to temporarily disable branch protection)
Our documentation is in a separate repository and updating it is a three step process:
- Write and update the change log
- Bump package version/s and create / update the pages for each version change
- Perform documentation updates
Steps 2 and 3 are typically raised as separate pull requests to make changes easier to review.
This is as simple as duplicating the latest page and updating the version number to match the release. Some things to keep in mind:
- We only provide live demos for the latest version of a package so you must remember to disable/remove the previous live demo (this avoids breaking changes affecting old versions in our docs)
- If the incoming version is a patch which doesn't require a docs update then you can simply change the page name to match the new version rather than duplicating the same content