Add release script and documentation

x-govuk · Nov 17, 2023 · 0f5f86c · 0f5f86c
1 parent e567538
commit 0f5f86c
Show file tree

Hide file tree

Showing 3 changed files with 4,614 additions and 744 deletions.
diff --git a/README.md b/README.md
@@ -118,3 +118,12 @@ It is not possible to import individual components using CommonJS.
 The project repository is public and anyone can contribute.
 
 [View this project on GitHub](https://github.com/x-govuk/govuk-prototype-components).
+
+## 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.