From ad36f0eee402a90aaf3eafb940387a9e6bc241d4 Mon Sep 17 00:00:00 2001 From: Assad Khan Date: Thu, 3 Oct 2024 13:45:24 +0100 Subject: [PATCH] fix: add further information to the README around the publishing workflow --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2b1dd62..19aa3d6c 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ For components to be styled correctly they will need access to a theme, some glo If you're using the Next.js App router your root layout should look something like: ```typescript -// layout.js +// layout.js import { OakThemeProvider, oakDefaultTheme, OakGlobalStyle } from "@oaknational/oak-components"; import { Lexend } from "next/font/google"; @@ -61,6 +61,16 @@ We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) an Changes should go through a pull-request to `main` and require approval by at least 1 reviewer. You should seek reviews from a QA/designer/PM when necessary. +The release process is driven by the commit messages, following the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/#specification). The `@semantic-release/commit-analyzer` plugin will determine the type of release (major, minor, or patch) based on the commit message. + +Here’s a summary of the commit types that trigger a release: + +* Patch release (x.x.x): Commits that start with `fix:` or contain other conventional keywords indicating bug fixes. +* Minor release (x.x.0): Commits that start with `feat:` indicate a new feature but not a breaking change. +* Major release (x.0.0): Commits that contain `BREAKING CHANGE:` in their description, which indicates a breaking change that requires a major version bump. + +Commit messages that begin with `chore`, `refactor` or `docs`, etc. will not trigger the release process. + ## Testing components inside a host app like OWA Sometimes it isn't enough to develop entirely inside Storybook and it might be necessary to try local changes inside a target app. You can do this with [yalc](https://github.com/wclr/yalc)