How to Publish a New Release

How to Publish a New Release

This project supports two types of releases:

• Stable Release: Production-ready versions.
• Alpha Release: Pre-release versions for testing.

The publishing process is automated via GitHub Actions based on specific tag patterns:

• Stable: vX.Y.Z (e.g., v1.0.0)
• Alpha: vX.Y.Z-alpha.N (e.g., v1.0.0-alpha.1)

Publishing a Stable Release

1. Update package.json Version:
   Update the version in package.json (e.g., "version": "1.0.0") or use:

   npm version [patch | minor | major]

2. Push a PR:
   Create a pull request with the version change. After review, merge it into the main branch.

3. Create a Release Tag:

   • After the PR is merged, go to the new release page on GitHub.
   • Set the tag to match your package.json version (e.g., v1.0.0) and ensure it is created from the main branch.
   • Ensure the target branch is main.
   • For major releases, set the previous tag to the previous major version. For minor updates or patches, set it to auto.
   • Click Generate release notes and review or edit the notes as needed.
   • Click Publish release.

4. Verify:
   The package will be published to npm under the latest tag. Verify on the npm registry or by installing it locally:

   npm install <package-name>@latest

Publishing an Alpha Release

1. Create an Alpha Release Tag: No need to update package.json for alpha releases — GitHub Actions handles it.

   • Go to the Releases page.
   • Set the tag as vX.Y.Z-alpha.N (e.g., v1.0.0-alpha.1).
   • Click Publish Release.

2. Verify:
   The package will be published to npm under the alpha tag. Verify the alpha version on the npm registry:

   npm install <package-name>@alpha