This document outlines the process for creating new releases of Wavy WhatsApp CLI.
We follow Semantic Versioning (SemVer) for version numbers:
- MAJOR version for incompatible API changes (e.g., v1.0.0 to v2.0.0)
- MINOR version for new functionality in a backward-compatible manner (e.g., v1.0.0 to v1.1.0)
- PATCH version for backward-compatible bug fixes (e.g., v1.0.0 to v1.0.1)
-
Ensure the codebase is ready for release:
- All features for this version are complete
- Tests are passing
- Documentation is up-to-date
-
Create and push a new tag:
# Replace X.Y.Z with the appropriate version number git tag -a vX.Y.Z -m "Release version X.Y.Z" git push origin vX.Y.Z
-
The GitHub Actions workflow will automatically:
- Build the binaries for multiple platforms (Linux, macOS, Windows)
- Create a GitHub Release with those binaries
- Generate release notes based on commits since the last release
-
Once the workflow completes, visit the Releases page to verify the new release.
Each release includes the following binaries:
- Linux (amd64, arm64)
- macOS (amd64, arm64)
- Windows (amd64)
For pre-releases, use suffixes like -alpha, -beta, or -rc in your tag:
git tag -a vX.Y.Z-alpha -m "Alpha release X.Y.Z"
git push origin vX.Y.Z-alphaBefore tagging a release, ensure:
- All features planned for this release are complete
- Tests are passing
- Documentation is updated
- CHANGELOG.md is updated (if applicable)
- README.md has the latest information