@bcgov/design-system-react-components 0.5.1-pr558 → 0.5.2-pr
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 +8 -15
- package/dist/cjs/index.cjs +9882 -8267
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.js +9901 -8286
- package/dist/esm/index.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# @bcgov/design-system-react-components
|
|
2
2
|
|
|
3
|
-
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
|
|
4
|
-
|
|
5
3
|
This package contains a library of React components built using [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html) to implement the [B.C. Design System](https://gov.bc.ca/designsystem).
|
|
6
4
|
|
|
7
5
|
Questions? Please email the <a href="mailto:DesignSystem@gov.bc.ca">GDX OSS Design Team</a>.
|
|
@@ -153,13 +151,14 @@ Run `npm run vite-dev` to access the Vite React demo app.
|
|
|
153
151
|
|
|
154
152
|
#### npm package
|
|
155
153
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
This will place artifacts in the `dist` folder, which is targeted for publishing in `package.json` with the [`files` field](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files).
|
|
154
|
+
Publishing new versions of the package to npm is done via GitHub Actions.
|
|
159
155
|
|
|
160
|
-
|
|
156
|
+
GitHub Actions are located in `/.github/workflows` in the project root. Actions are included to:
|
|
161
157
|
|
|
162
|
-
|
|
158
|
+
- Build the Storybook and Vite applications on merge to `main`
|
|
159
|
+
- Test (Jest and Playwright) on pull request
|
|
160
|
+
- Publish new versions of the library on npm (`next` tag) on merge to `main`
|
|
161
|
+
- Publish new versions of the library on npm (`latest` tag) when a GitHub release is published
|
|
163
162
|
|
|
164
163
|
#### GitHub release
|
|
165
164
|
|
|
@@ -177,12 +176,6 @@ From the [Releases page](https://github.com/bcgov/design-system/releases), click
|
|
|
177
176
|
|
|
178
177
|
For "Choose a tag", select the tag you created. For the previous tag, use the previous version of the same package.
|
|
179
178
|
|
|
180
|
-
Copy the
|
|
179
|
+
Copy the changelog notes for the new version and link to the npm page for the new version. Ensure that `package.json` has been updated with the correct version number.
|
|
181
180
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
GitHub Actions are located in `/.github/workflows` in the project root. Actions are included to:
|
|
185
|
-
|
|
186
|
-
- Build the Storybook and Vite applications on merge to `main`
|
|
187
|
-
- Test (Jest and Playwright) on pull request
|
|
188
|
-
- Publish new versions of the library on npm (`next` tag) on merge to `main`
|
|
181
|
+
Publish the release to publish the latest version of the library on npm. The release tag must start with `@bcgov/design-system-react-components` to trigger the publish workflow.
|