@oaknational/oak-components 1.61.1 β 1.63.0
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 +4 -4
- package/dist/cjs/index.js +3 -3
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.js +2 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/types.d.ts +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ This library is suitable for use in an app using React 18 and Next.js 13.5+
|
|
|
14
14
|
|
|
15
15
|
You can install it using `npm i @oaknational/oak-components` or any other package manager that supports the NPM registry.
|
|
16
16
|
|
|
17
|
-
π You'll need two environment variables to enable
|
|
17
|
+
π You'll need two environment variables to enable images `NEXT_PUBLIC_OAK_ASSETS_HOST` and `NEXT_PUBLIC_OAK_ASSETS_PATH`. Values for these can be obtained from the `.env` config from OWA or from a fellow engineer.
|
|
18
18
|
|
|
19
19
|
### Theming, global styles and fonts
|
|
20
20
|
|
|
@@ -65,9 +65,9 @@ The release process is driven by the commit messages, following the [Conventiona
|
|
|
65
65
|
|
|
66
66
|
Hereβs a summary of the commit types that trigger a release:
|
|
67
67
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
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
71
|
|
|
72
72
|
Commit messages that begin with `chore`, `refactor` or `docs`, etc. will not trigger the release process.
|
|
73
73
|
|