Github Actions

We have a few Github Action workflows in the repo, below are a few details on the workflows

Github Pages

github-pages.yml

This workflow builds the web app of the site

Unit tests

unit-tests.yml

This workflow runs the unit tests, if any do not pass, the workflow should fail. This only needs to run on Pull requests into main

Github Tag and Release

github-tag-release

This tags the repo, builds the projects, creates a release with the version number in package.json and uploads the build files to the release.

Github Trigger Documentation Build

github-tag-release

This triggers a different repository to build and publish our documentation on a different url that is hosted on Github Pages. This includes building this documentation site, the Storybook export and unit test coverage report

Pull Request Checks

pr-checks.yml Work In Progress, this workflow will perform several checks to make sure that the changes in the PR are adequate.

Commit message check

commit-message-check.yml Work In Progress, this workflow will check all the commits that are about to be merged into main