@cruk/chakra-components 4.0.0-dev.7 → 4.0.0-dev.8

package/README.md

@@ -1,7 +1,7 @@
-# CRUK Chakra Components 🎨
-
 ![Logo](.github/assets/logo.png)
 
+# CRUK Chakra Components 🎨
+
 A [Chakra UI v2](https://v2.chakra-ui.com/docs/) based component library that provides styled components following the [Cancer Research UK Helix design system](https://zeroheight.com/721bd94bd/p/074a6c-helix-design-system---cancer-research-uk) 🧬.
 It is a Work In Progress.
 
@@ -18,15 +18,11 @@ It is a Work In Progress.
 
 Depending on your project, you might install the library in the project root directory, or in `client`:
 
-## Install the package
-
 ```bash
+# Install the package
 npm install @cruk/chakra-components
-```
-
-## Install peer dependencies (if you don't already have them)
 
-```bash
+# Install peer dependencies (if you don't already have them)
 npm install @chakra-ui/react @emotion/react @emotion/styled framer-motion
 ```
 
@@ -36,7 +32,7 @@ npm install @chakra-ui/react @emotion/react @emotion/styled framer-motion
 
 Once added to the project, you can use the `ChakraBaseProvider` to wrap your application and provide styled based on the `crukBrand` theme.
 
-`````typescript
+```typescript
 import type { AppProps } from "next/app";
 import { ChakraBaseProvider, crukBrand } from "@cruk/chakra-components";
 
@@ -47,7 +43,7 @@ const App = ({ Component, pageProps }: AppProps) => (
 );
 
 export default App;
-```js
+```
 
 - 📖 [Styling documentation](https://super-succotash-wg8qmo1.pages.github.io/styling)
 - 📖 [Theming documentation](https://super-succotash-wg8qmo1.pages.github.io/theming)
@@ -58,32 +54,28 @@ export default App;
 
 After cloning the repository, install the dependencies:
 
-````bash
+```bash
 # Clone and setup
 git clone https://github.com/CRUKorg/cruk-chakra-components
 cd cruk-chakra-components
 npm ci
 
 # Start Storybook
-Ensure your npm v matches repo and run story book
-```bash
-nvm use && npm run storybook
-`````
+npm run storybook
+```
 
 ### Quick Test
 
-Ensure right version of node and run tests.
-
 ```bash
-nvm use && npm run test     # Unit tests
-nvm use && npm run test-ct  # Component tests
+npm run test     # Unit tests
+npm run test-ct  # Component tests
 ```
 
 ## Deployment and Releases 🚀
 
 ### Release Process
 
-This library uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate versioning and package publishing based on **pull request titles** and **commit content**.
+This library uses [semantic-release](https://github.com/semantic-release/semantic-release) with **GitHub PR labels** to automate versioning and package publishing.
 
 #### Branch Strategy
 
@@ -92,54 +84,33 @@ This library uses [semantic-release](https://github.com/semantic-release/semanti
 
 #### Release Requirements
 
-**Important:** Only pull requests with `RELEASE` in the title will trigger a release. The version type (major/minor/patch) is determined by the commit content within that PR.
+**Important:** Only pull requests with the `release` label will trigger a release. The version type is determined by additional labels.
 
 #### Creating a Release
 
-1. **Create your pull request with `RELEASE` in the title:**
+1. **Create your pull request and add labels:**
 
-   ```none
-   RELEASE: Add new Button component
-   RELEASE: Fix accessibility issues
-   Feature update - RELEASE v2.1.0
-   ```
+   **Required label:**
+   - `release` - Must be present to trigger any release
 
-1. **Use conventional commit messages** within your PR to determine the release type:
+   **Version labels (choose one):**
+   - `breaking` or `major` - Major release (v1.0.0 → v2.0.0)
+   - `minor` - Minor release (v1.0.0 → v1.1.0)
+   - `patch` - Patch release (v1.0.0 → v1.0.1)
 
-   **Patch Release** (v1.0.0 → v1.0.1):
+   If only the `release` label is present, it defaults to a patch release.
 
-   ```none
-   fix: resolve Button focus state issue
-   docs: update component documentation
-   test: add missing unit tests
-   refactor: improve component structure
-   ```
+2. **For main branch releases: Obtain ServiceNow approval**
 
-   **Minor Release** (v1.0.0 → v1.1.0):
+   **Important:** All releases to the `main` branch require an approved ServiceNow change request before merging. This is mandatory for production deployments.
 
-   ```none
+3. **Merge your PR** to the appropriate branch:
 
-   feat: add new Button variant
-   feature: implement dark mode support
+   - Merge to `dev` for prerelease versions (no ServiceNow required)
+   - Merge to `main` for standard releases (ServiceNow approval required)
 
-   ```
-
-   **Major Release** (v1.0.0 → v2.0.0):
-
-```none
-
- feat: redesign Button component API
-
- BREAKING CHANGE: The Button component no longer accepts 'size' prop, use 'buttonSize' instead.
-
-```
-
-1. **Merge your PR** to the appropriate branch:
-   - Merge to `dev` for prerelease versions
-   - Merge to `main` for standard releases
-
-2. The semantic-release system will automatically:
-   - Analyse the PR title and commit content
+4. The semantic-release system will automatically:
+   - Read the PR labels
    - Determine the appropriate version bump
    - Generate release notes
    - Publish to npm
@@ -148,24 +119,17 @@ This library uses [semantic-release](https://github.com/semantic-release/semanti
 #### Examples
 
 ✅ **Will trigger a minor release:**
-
-- PR title: "RELEASE: Add new components"
-- Contains commit: "feat: add new Button variant"
+- Labels: `release`, `minor`
 
 ✅ **Will trigger a patch release:**
-
-- PR title: "RELEASE: Bug fixes"
-- Contains commit: "fix: resolve styling issue"
+- Labels: `release`, `patch`
+- Labels: `release` (defaults to patch)
 
 ✅ **Will trigger a major release:**
-
-- PR title: "RELEASE: Breaking API changes"
-- Contains commit with: "BREAKING CHANGE: removed deprecated props"
+- Labels: `release`, `breaking`
 
 ❌ **Will NOT trigger any release:**
-
-- PR title: "Add new components" (missing "RELEASE")
-- Even with commits like "feat: new component"
+- No `release` label present
 
 #### Manual Release
 
@@ -175,12 +139,12 @@ If needed, you can manually trigger a release:
 npm run release
 ```
 
-### Resources 📖
+## Resources 📖
 
 - [Component Examples (Storybook)](https://helix-components.cms.app.crnet.org)
 - [Full Documentation (Style guide, Theming, Testing and more)](https://super-succotash-wg8qmo1.pages.github.io/)
 - [Need help? Message us on Slack](https://cruk.slack.com/archives/C07BNR9FY4E)
 
-#### 📄 Licence
+## 📄 Licence
 
 MIT © Cancer Research UK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cruk/chakra-components",
-  "version": "4.0.0-dev.7",
+  "version": "4.0.0-dev.8",
   "description": "Chakra UI v2 based components for CRUK applications",
   "license": "MIT",
   "sideEffects": false,