bs-widget 1.0.2 → 1.0.3
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 +23 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Add a container element where the widget should render, include the script, then
|
|
|
10
10
|
|
|
11
11
|
```html
|
|
12
12
|
<div id="bs-widget"></div>
|
|
13
|
-
<script src="https://unpkg.com/bs-widget@1.0.
|
|
13
|
+
<script src="https://unpkg.com/bs-widget@1.0.2/dist/bundle.js"></script>
|
|
14
14
|
<script>
|
|
15
15
|
let widget = new BSWidget({
|
|
16
16
|
microsite: 6,
|
|
@@ -26,7 +26,7 @@ Add a container element where the widget should render, include the script, then
|
|
|
26
26
|
You can also use jsDelivr:
|
|
27
27
|
|
|
28
28
|
```html
|
|
29
|
-
<script src="https://cdn.jsdelivr.net/npm/bs-widget@1.0.
|
|
29
|
+
<script src="https://cdn.jsdelivr.net/npm/bs-widget@1.0.2/dist/bundle.js"></script>
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
### Option B: Local build
|
|
@@ -130,4 +130,24 @@ Run all checks before publishing:
|
|
|
130
130
|
yarn verify
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
`prepublishOnly` runs the same verification automatically to prevent publishing without a fresh passing build.
|
|
133
|
+
`prepublishOnly` runs the same verification automatically to prevent publishing without a fresh passing build.
|
|
134
|
+
|
|
135
|
+
## Automated release (npm + GitHub Release)
|
|
136
|
+
|
|
137
|
+
This repo includes a tag-driven workflow at `.github/workflows/release.yml`.
|
|
138
|
+
|
|
139
|
+
1. Bump the package version in `package.json`.
|
|
140
|
+
2. Commit and push your changes.
|
|
141
|
+
3. Create and push a matching tag (`v` + package version):
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
git tag v1.0.2
|
|
145
|
+
git push origin v1.0.2
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
On tag push, GitHub Actions will:
|
|
149
|
+
|
|
150
|
+
- validate tag version matches `package.json`
|
|
151
|
+
- run `yarn verify`
|
|
152
|
+
- publish to npm
|
|
153
|
+
- create a GitHub Release with generated notes
|