This document outlines the steps required to release a new version of the package on npm using GitHub Actions for automated publishing.
- You have a local clone of the repository.
- Your
package.jsonfile is properly configured with a unique package name. - An npm token is added to GitHub Secrets as
NPM_TOKEN. - A GitHub Actions workflow file (e.g.,
.github/workflows/publish.yml) is configured to publish the package on tag push. - All changes are thoroughly tested.
-
Build the project:
If your build script is defined as:
npm run buildCurrently project don't have tests, you can run examples files for make sure that project work correcly.
-
Bump the package version:
For a patch update, run:
npm version patchor
npm version minor/npm version majoras needed.This command updates the version in package.json, creates a commit, and generates a new tag (e.g.,
v0.0.2). -
Push Changes:
Execute
git push origin master --tagsAutomated Publishing: The GitHub Actions workflow will automatically build, test, and publish your package to npm.