Building the product

Make sure your project is built before you release. You can build the product with the following command:

yarn product:build

Preparing for deployment

If you want to take advantage of Github Actions and continuosly deploy your product and storybook to Github Pages, you will need to set a few things:

• Make sure your working repository is public, and the deployment branch is set to "gh-pages". It can be checked and fixed in repository settinds on Github.

• You need to edit "homepage" property in ./product/package.json. It should be pointing to your repository.

{
  "homepage": "https://<USERNAME>.github.io/<REPOSITORY_NAME>",
  ...
}

Releasing the product

1. When you are ready to release the product, you need to run the following command to bump the version:

yarn product:version

2. As soon as you push your commits to main branch, a Github Action(.github/workflows/release.yml) will be triggered. It performs two tasks:

• Checks the version of the product and compare it with previous one.
• If version change is detected, build and deploy workflow is activated.

Deploy won't run if the version is the same. If you still need to deploy the previous version for some reason, you can run it manually:

yarn deploy