@oaknational/oak-components 1.38.0 → 1.38.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,7 +23,7 @@ For components to be styled correctly they will need access to a theme, some glo
23
23
  If you're using the Next.js App router your root layout should look something like:
24
24
 
25
25
  ```typescript
26
- // layout.js
26
+ // layout.js
27
27
  import { OakThemeProvider, oakDefaultTheme, OakGlobalStyle } from "@oaknational/oak-components";
28
28
  import { Lexend } from "next/font/google";
29
29
 
@@ -61,6 +61,16 @@ We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) an
61
61
 
62
62
  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.
63
63
 
64
+ 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.
65
+
66
+ Here’s a summary of the commit types that trigger a release:
67
+
68
+ * Patch release (x.x.x): Commits that start with `fix:` or contain other conventional keywords indicating bug fixes.
69
+ * Minor release (x.x.0): Commits that start with `feat:` indicate a new feature but not a breaking change.
70
+ * Major release (x.0.0): Commits that contain `BREAKING CHANGE:` in their description, which indicates a breaking change that requires a major version bump.
71
+
72
+ Commit messages that begin with `chore`, `refactor` or `docs`, etc. will not trigger the release process.
73
+
64
74
  ## Testing components inside a host app like OWA
65
75
 
66
76
  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)