Merge pull request #60 from simonireilly/main

Perform release automation using github release tags

Author: kevinkuszyk

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: CD Build and Publish to NPM
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      
+      - name: Yarn Install
+        run: yarn
+      
+      - name: Lint
+        run: yarn lint
+      
+      - name: Jest Tests
+        run: yarn test:ci
+      
+      - name: Typescript build
+        run: yarn build
+      
+      - name: Set Version to Release Tag Name
+        run: |
+          yarn version --new-version ${{ github.event.release.tag_name }} --no-git-tag-version
+      
+      - name: Publish to npm, publish pre-release as beta
+        uses: JS-DevTools/npm-publish@v1 
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          dry-run: true
+          tag: ${{ github.event.release.prerelease && 'beta' || 'latest' }}

README.md

@@ -1,5 +1,13 @@
 # NHS.UK React Components
 
+- [NHS.UK React Components](#nhsuk-react-components)
+  - [Coming from 0.x?](#coming-from-0x)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Storybook](#storybook)
+  - [Maintainers](#maintainers)
+    - [Preparing Releases](#preparing-releases)
+
 NHS.UK Frontend ported to React
 
 [![GitHub Actions CI Status](https://github.com/NHSDigital/nhsuk-react-components/workflows/CI/badge.svg)](https://github.com/NHSDigital/nhsuk-react-components/actions?query=workflow%3A%22CI+Build%22+branch%3Amain) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/nhsuk-react-components.svg)](https://bundlephobia.com/result?p=nhsuk-react-components)
@@ -47,3 +55,14 @@ A storybook containing all of the components and their usage can be found [here]
 - Thomas Judd-Cooper ([GitHub](https://github.com/tomdango))
 - Sam Brown ([GitHub](https://github.com/samueldavidbrown))
 - Luke Pearson ([GitHub](https://github.com/lukepearson))
+
+### Preparing Releases
+
+Releases run in CI using github actions. 
+
+To prepare a release create a new release TAG in github with your release version.
+
+>`NPM_TOKEN` should be stored in the repositories [secrets in GitHub](https://github.com/NHSDigital/nhsuk-react-components/settings/secrets/actions)
+
+- Create a new release with a tag like `major.minor.patch` against main.
+- If the change is a `beta` then select `pre-release` as true, this will make the `tag` point at `beta`. Otherwise the tag will be `latest`.