studio/integration
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: explain how to publish a new integration package

Browse Source
This commit is contained in:
Emmanuel Pelletier
2025-04-17 17:47:44 +02:00
parent 1c09b66c58
commit ef0d56f169
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
packages/integration/README.md
View File

@@ -54,3 +54,14 @@ CSS is rendered like that, and not through the main vite config, because CSS ren
The `html-config` generates the HTML files. The `html-config` generates the HTML files.
**HTML files are not written by hand**: they are generated from the React components. The html vite config checks the `src/html.tsx` file and renders HTML files for every template listed. **HTML files are not written by hand**: they are generated from the React components. The html vite config checks the `src/html.tsx` file and renders HTML files for every template listed.
### Publishing a new npm package
- run `npm version` with either `major`, `minor` or `patch` to bump the version. There is no precise versioning strategy for now, but following semver is a good idea. So: breaking changes should be `major` updates, new features should be `minor` updates and bug fixes should be `patch` updates.
- add a new entry in the `CHANGELOG.md` file to describe the changes.
- :warning: make sure your local `.env` file uses production values.
- run `npm pack` to generate a new tarball locally. It's an easy to verify manually that the package is good before publishing it.
- run `npm publish` to publish the package on npm.
- commit your changes.
- create a git tag on this new commit: `integration-vX.X.X`.
- push the main branch and the new tag on github.