@allsrvsonline/vue-component-library 0.3.0 → 0.3.2
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 +60 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -233,10 +233,66 @@ MIT
|
|
|
233
233
|
|
|
234
234
|
## Publishing
|
|
235
235
|
|
|
236
|
-
|
|
236
|
+
This project uses automated releases with conventional commits and GitHub Actions.
|
|
237
237
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
238
|
+
### Prerequisites
|
|
239
|
+
|
|
240
|
+
Before publishing, ensure these GitHub repository variables are configured:
|
|
241
|
+
|
|
242
|
+
1. **NPM_TOKEN** - npm authentication token
|
|
243
|
+
- Go to npmjs.com → Account Settings → Access Tokens → Generate New Token (Automation)
|
|
244
|
+
- Add as repository variable: `NPM_TOKEN` (in Settings → Variables)
|
|
245
|
+
|
|
246
|
+
2. **GITHUB_TOKEN** - Automatically provided by GitHub Actions (no setup needed)
|
|
247
|
+
|
|
248
|
+
3. **GITHUB_TOKEN** - Automatically provided by GitHub Actions (no setup needed)
|
|
249
|
+
|
|
250
|
+
### Release Process
|
|
251
|
+
|
|
252
|
+
Create releases using these npm scripts:
|
|
253
|
+
|
|
254
|
+
```bash
|
|
255
|
+
# Patch release (0.3.1 → 0.3.2)
|
|
256
|
+
npm run release:patch
|
|
257
|
+
|
|
258
|
+
# Minor release (0.3.1 → 0.4.0)
|
|
259
|
+
npm run release:minor
|
|
260
|
+
|
|
261
|
+
# Major release (0.3.1 → 1.0.0)
|
|
262
|
+
npm run release:major
|
|
263
|
+
|
|
264
|
+
# Preview what would happen
|
|
265
|
+
npm run release:dry-run
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
The release process automatically:
|
|
269
|
+
|
|
270
|
+
- ✅ Analyzes conventional commits
|
|
271
|
+
- ✅ Bumps version in package.json
|
|
272
|
+
- ✅ Updates CHANGELOG.md
|
|
273
|
+
- ✅ Creates git commit and tag
|
|
274
|
+
- ✅ Pushes to GitHub (triggers publish workflow)
|
|
275
|
+
- ✅ Publishes to npm
|
|
276
|
+
- ✅ Creates GitHub Release
|
|
277
|
+
|
|
278
|
+
### Conventional Commits
|
|
279
|
+
|
|
280
|
+
Use these commit message formats:
|
|
281
|
+
|
|
282
|
+
```bash
|
|
283
|
+
feat: add new component # → Minor version bump
|
|
284
|
+
fix: resolve button bug # → Patch version bump
|
|
285
|
+
docs: update README # → No version bump
|
|
286
|
+
BREAKING CHANGE: api change # → Major version bump
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Manual Publishing
|
|
290
|
+
|
|
291
|
+
If needed, you can still publish manually:
|
|
292
|
+
|
|
293
|
+
```bash
|
|
294
|
+
npm run build:lib
|
|
295
|
+
npm publish --access public
|
|
296
|
+
```
|
|
241
297
|
|
|
242
298
|
Make sure to update `@your-org/vue-component-library` in package.json with your actual organization/package name.
|