@boldvideo/bold-js 0.8.0 → 0.8.1
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/AGENTS.md +28 -2
- package/CHANGELOG.md +6 -0
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -22,10 +22,36 @@ pnpm install # Install dependencies
|
|
|
22
22
|
pnpm run build # Build to dist/ (ESM + CJS + type declarations)
|
|
23
23
|
pnpm run lint # Type checking with tsc
|
|
24
24
|
pnpm changeset # Create a changeset for versioning
|
|
25
|
-
pnpm changeset version # Apply changesets and bump versions
|
|
26
|
-
pnpm changeset publish # Publish to npm
|
|
27
25
|
```
|
|
28
26
|
|
|
27
|
+
## Release Workflow
|
|
28
|
+
|
|
29
|
+
This project uses [Changesets](https://github.com/changesets/changesets) with automated GitHub Actions for publishing.
|
|
30
|
+
|
|
31
|
+
### How to Release
|
|
32
|
+
|
|
33
|
+
1. **Create a changeset** when making changes that should be released:
|
|
34
|
+
```bash
|
|
35
|
+
pnpm changeset
|
|
36
|
+
```
|
|
37
|
+
This creates a markdown file in `.changeset/` describing the change and version bump type (patch/minor/major).
|
|
38
|
+
|
|
39
|
+
2. **Commit and push** your changes (including the changeset file) to `main`.
|
|
40
|
+
|
|
41
|
+
3. **Automated release process**:
|
|
42
|
+
- The `changeset-release.yml` workflow runs on push to `main`
|
|
43
|
+
- If changesets exist, it creates a "Release PR" that:
|
|
44
|
+
- Bumps the version in `package.json`
|
|
45
|
+
- Updates `CHANGELOG.md`
|
|
46
|
+
- Removes the changeset files
|
|
47
|
+
- When you merge that Release PR, the workflow automatically publishes to npm
|
|
48
|
+
|
|
49
|
+
### Important Notes
|
|
50
|
+
|
|
51
|
+
- **Never run `pnpm changeset version` or `pnpm changeset publish` locally** - the GitHub Action handles this automatically
|
|
52
|
+
- The CI workflow (`ci.yml`) runs `pnpm run build` which generates the `dist/` folder - this ensures compiled files are always included in the published package
|
|
53
|
+
- The `release.yml` workflow can also publish when a `v*` tag is pushed (alternative release method)
|
|
54
|
+
|
|
29
55
|
## Project Structure
|
|
30
56
|
|
|
31
57
|
```
|
package/CHANGELOG.md
CHANGED