@@ -252,6 +252,81 @@ npm run doc
252252}
253253```
254254
255+ ## Release Process
256+
257+ ### Prerequisites
258+
259+ - All changes committed and pushed to remote repository
260+ - GitHub access token configured for ` conventional-github-releaser `
261+ - npm account access for publishing
262+
263+ ### Release Steps
264+
265+ 1 . ** Commit and push changes:**
266+ ``` bash
267+ git add .
268+ git commit -m " feat: add new feature" # Use conventional commit format
269+ git push origin main
270+ ```
271+
272+ 2 . ** Build the library:**
273+ ``` bash
274+ npm run build
275+ ```
276+
277+ 3 . ** Update version and create release:**
278+ ``` bash
279+ npm version patch # or minor, major
280+ ```
281+ This command automatically:
282+ - Updates version in ` package.json `
283+ - Creates Git tag
284+ - Pushes tag to remote repository
285+ - Creates GitHub release
286+ - Updates ` CHANGELOG.md `
287+
288+ 4 . ** Verify release artifacts:**
289+ ``` bash
290+ # Check if tag was created
291+ git tag -l | tail -3
292+
293+ # Check if CHANGELOG was updated
294+ git log --oneline -2
295+ ```
296+
297+ 5 . ** Publish to npm:**
298+ ``` bash
299+ npm publish
300+ ```
301+
302+ ### Version Management
303+
304+ - ** patch** : Bug fixes and minor updates (1.2.1 → 1.2.2)
305+ - ** minor** : New features (1.2.1 → 1.3.0)
306+ - ** major** : Breaking changes (1.2.1 → 2.0.0)
307+
308+ ### Automated Processes
309+
310+ The release process uses several npm scripts that run automatically:
311+
312+ - ** ` postversion ` ** : Automatically executes after ` npm version `
313+ - ** ` push:tag ` ** : Pushes Git tag to remote repository
314+ - ** ` create:release ` ** : Creates GitHub release with conventional changelog
315+ - ** ` create:changelog ` ** : Updates local ` CHANGELOG.md ` file
316+
317+ ### Troubleshooting
318+
319+ If the automated release process fails:
320+
321+ ``` bash
322+ # Manually execute release scripts
323+ npm run push:tag
324+ npm run create:release
325+ npm run create:changelog
326+ ```
327+
328+ Check GitHub repository settings and ensure proper authentication tokens are configured.
329+
255330## Architecture
256331
257332The library consists of three main components:
0 commit comments