@bloodhoundenterprise/doodleui 1.0.0-alpha.32 → 1.0.0-alpha.33
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 +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="https://img.shields.io/badge/version-1.0.0--alpha.
|
|
2
|
+
<img src="https://img.shields.io/badge/version-1.0.0--alpha.33-teal" alt="version 1.0.0-alpha.33"/>
|
|
3
3
|
<a href="https://ghst.ly/BHSlack">
|
|
4
4
|
<img src="https://img.shields.io/badge/BloodHound Slack-4A154B?logo=slack&logoColor=EEF0F2"
|
|
5
5
|
alt="BloodHound Slack"></a>
|
|
@@ -112,6 +112,21 @@ yarn dev
|
|
|
112
112
|
| format:write | Fix file formatting |
|
|
113
113
|
| update-badge | Updates the version badge in the [README](README.md) |
|
|
114
114
|
|
|
115
|
+
### Publishing a new DoodleUI version
|
|
116
|
+
|
|
117
|
+
PRs which include changes to components must also increment the version number in `package.json` (in accordance with [semver](https://semver.org/)), otherwise these changes will not be publishable. Once a PR with a new version has been merged into main, complete the following steps to publish the new version to NPM:
|
|
118
|
+
|
|
119
|
+
- Checkout main branch and pull latest changes from remote
|
|
120
|
+
- Run the following scripts (found in package.json):
|
|
121
|
+
- `build:styles`
|
|
122
|
+
- `build:storybook`
|
|
123
|
+
- `format:write`
|
|
124
|
+
- `yarn build`
|
|
125
|
+
- `npm login (use credentials in 1password)`
|
|
126
|
+
- `npm publish —-access public`
|
|
127
|
+
|
|
128
|
+
Now, any package which depends on DoodleUI will be able to access the latest version of the library by updating their `package.json` to reference the new version number.
|
|
129
|
+
|
|
115
130
|
## Licensing
|
|
116
131
|
|
|
117
132
|
```
|