This is an automated email from the ASF dual-hosted git repository.
xyz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-client-node.git
The following commit(s) were added to refs/heads/master by this push:
new 0272b3a Add Versioning Rule to Release Process (#287)
0272b3a is described below
commit 0272b3a5424e70f2115a70c2b445d54b8edf3413
Author: Yuto Furuta <[email protected]>
AuthorDate: Tue Jan 17 21:57:53 2023 +0900
Add Versioning Rule to Release Process (#287)
### Motivation
The versioning rule of Node.js Client is not explicitly written.
### Modifications
Add Versioning Rule to Release process.
Co-authored-by: Yuto Furuta <[email protected]>
---
docs/release-process.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/release-process.md b/docs/release-process.md
index b721eae..68d4015 100644
--- a/docs/release-process.md
+++ b/docs/release-process.md
@@ -34,6 +34,17 @@ The steps for releasing are as follows:
9. Update release notes
10. Announce the release
+## Versioning
+Bump up the version number as follows.
+
+* Major version (e.g. 1.8.0 => 2.0.0)
+ * Changes that break backward compatibility
+* Minor version (e.g. 1.8.0 => 1.9.0)
+ * Backward compatible new features
+* Patch version (e.g. 1.8.0 => 1.8.1)
+ * Backward compatible bug fixes
+ * C++ Client upgrade (even though there are no new commits in the Nodejs
client)
+
## Requirements
If you haven't already done it, [create and publish the GPG
key](https://pulsar.apache.org/contribute/releasing/create-gpg-keys) to sign
the release artifacts.
