Add release script and documentation

x-govuk · Dec 10, 2023 · 72c6b94 · 72c6b94
1 parent 1f3595a
commit 72c6b94
Show file tree

Hide file tree

Showing 3 changed files with 6,023 additions and 1,695 deletions.
diff --git a/README.md b/README.md
@@ -302,3 +302,12 @@ s3. Love numbers.
   <li>Love numbers.</li>
 </ol>
 ```
+
+## Releasing a new version
+
+`npm run release`
+
+This command will ask you what version you want to use. It will then publish a new version on NPM, create and push a new git tag and then generate release notes ready for posting on GitHub.
+
+> [!NOTE]
+> Releasing a new version requires permission to publish packages to the `@x-govuk` organisation.