This is an automated email from the ASF dual-hosted git repository.
nkurihar 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 f41a912 [refactor] Change release process (#243)
f41a912 is described below
commit f41a9127267ad03a94eea83163a0342085a2a256
Author: Baodi Shi <[email protected]>
AuthorDate: Thu Nov 10 15:18:08 2022 +0800
[refactor] Change release process (#243)
* Copy wiki release process.
* Change releae process
* Add explan set github token
---
docs/release-process.md | 242 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 242 insertions(+)
diff --git a/docs/release-process.md b/docs/release-process.md
new file mode 100644
index 0000000..ee0607c
--- /dev/null
+++ b/docs/release-process.md
@@ -0,0 +1,242 @@
+This page contains instructions for Pulsar committers on how to perform a
release.
+
+## Making the release
+
+The steps for releasing are as follows:
+1. Check and Add TypeScript Types
+2. Create the release branch
+3. Update package version and tag
+4. Sign and stage the artifacts
+5. Move master branch to next version
+6. Write release notes
+7. Run the vote
+8. Promote the release
+9. Update release notes
+10. Announce the release
+
+## 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.
+
+## Steps in detail
+
+#### 1. Check and Add TypeScript Types
+
+In order to use added features and options in TypeScript code, we need to add
their type definitions.
+
+Check if there are any Pull Requests with the `types-required` label or not.
+If yes, add their type definitions (e.g.
https://github.com/apache/pulsar-client-node/pull/157).
+If no, we can then proceed to next step.
+
+#### 2. Create the release branch
+
+We are going to create a branch from `master` to `branch-1.X` where the tag
will be generated
+and where new fixes will be applied as part of the maintenance for the release.
+
+The branch needs only to be created when creating minor releases, and not for
patch releases.
+
+Eg: When creating `v1.1.0` release, will be creating the branch `branch-1.1`,
+but for `v1.1.1` we would keep using the old `branch-1.1`.
+
+In these instructions, I'm referring to an fictitious release `1.X.0`.
+Change the release version in the examples accordingly with the real version.
+
+It is recommended to create a fresh clone of the repository to avoid any local
files to interfere
+in the process:
+
+```sh
+$ git clone [email protected]:apache/pulsar-client-node.git
+$ cd pulsar-client-node
+$ git checkout -b branch-1.X origin/master
+```
+
+#### 3. Update package version and tag
+
+During the release process, we are going to initially create "candidate" tags:
+```sh
+# Bump to the release version (the suffix "-rc.0" is removed)
+$ npm version patch --no-git-tag-version
+$ git add .
+$ git commit -m 'Release v1.x.0'
+
+# Create a "candidate" tag
+$ export GPG_TTY=$(tty)
+$ git tag -u [email protected] v1.X.0-rc.1 -m 'Release v1.X.0-rc.1'
+
+# Push both the branch and the tag to GitHub repo
+$ git push origin branch-1.X
+$ git push origin v1.X.0-rc.1
+```
+
+#### 4. Sign and stage the artifacts
+The src artifact need to be signed and uploaded to the dist SVN repository for
staging. See
[here](https://github.com/apache/pulsar/wiki/Create-GPG-keys-to-sign-release-artifacts)
for how to setup gpg.
+
+When the build is pushed to the Apache repo, a Github action job will run and
build all the binary artifacts.
+
+The build will be available at
`https://github.com/apache/pulsar-client-node/actions`
+
+Once the workflow is completed (ETA ~20 min), the artifacts will be available
for download.
+
+Record the id of the workflow as `WORKFLOW_ID`.
+
+All the artifacts need to be signed and uploaded to the dist SVN repository
for staging.
+
+Before running the script, make sure that the `[email protected]` code signing
key is the default gpg signing key. One way to ensure this is to create/edit
file `~/.gnupg/gpg.conf` and add a line
+
+```sh
+default-key <key fingerprint>
+```
+
+where` <key fingerprint>` should be replaced with the private key fingerprint
for the `[email protected]` key. The key fingerprint can be found in `gpg -K`
output.
+
+```sh
+$ svn co https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node
pulsar-dist-dev
+$ cd pulsar-dist-dev
+
+# '-candidate-1' needs to be incremented in case of multiple iterations in
getting
+# to the final release)
+$ svn mkdir pulsar-client-node-1.X.0-candidate-1
+
+# Generate token from here: https://github.com/settings/tokens
+$ export GITHUB_TOKEN=${Your github token}
+$ $PULSAR_PATH/build-support/stage-release.sh . $WORKFLOW_ID
+
+$ svn add *
+$ svn ci -m 'Staging artifacts and signature for Pulsar Node.js client release
1.X.0-candidate-1'
+```
+
+#### 5. Move master branch to next version
+
+We need to move master version to next iteration `X + 1`.
+
+```sh
+$ git checkout master
+$ npm version preminor --preid=rc
+```
+
+Since this needs to be merged in `master`, we need to follow the regular
process
+and create a Pull Request on GitHub.
+
+#### 6. Write release notes
+
+Check the milestone in GitHub associated with the release.
+https://github.com/apache/pulsar-client-node/milestones?closed=1
+
+In the release item, add the list of most important changes that happened in
the release
+and a link to the associated milestone, with the complete list of all the
changes.
+https://github.com/apache/pulsar-client-node/releases
+
+#### 7. Run the vote
+
+Send an email on the Pulsar Dev mailing list:
+
+```
+To: [email protected]
+Subject: [VOTE] Pulsar Node.js Client Release 1.X.0 Candidate 1
+
+Hi everyone,
+Please review and vote on the release candidate #1 for the version 1.X.0, as
follows:
+[ ] +1, Approve the release
+[ ] -1, Do not approve the release (please provide specific comments)
+
+This is the first release candidate for Apache Pulsar Node.js client, version
1.X.0.
+
+It fixes the following issues:
+https://github.com/apache/pulsar-client-node/milestone/1?closed=1
+
+Please download the source files and review this release candidate:
+- Review release notes
+- Download the source package (verify shasum and asc) and follow the README.md
to build and run the Pulsar Node.js client.
+
+The vote will be open for at least 72 hours. It is adopted by majority
approval, with at least 3 PMC affirmative votes.
+
+Source files:
+https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-candidate-1/
+
+Pulsar's KEYS file containing PGP keys we use to sign the release:
+https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+
+SHA-512 checksum:
+5f6c7e1a096a3ae66eee71c552af89532ed86bf94da3f3d49836c080426ee5dcaabeda440a989d51772d2e67e2dca953eeee9ea83cfbc7c2a0847a0ec04b310f
pulsar-client-node-1.X.0.tar.gz
+
+The tag to be voted upon:
+v1.X.0-rc.1
+https://github.com/apache/pulsar-client-node/releases/tag/v1.X.0-rc.1
+```
+
+The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC
members
+will be considered binding, while anyone else is encouraged to verify the
release and
+vote as well.
+
+If the release is approved here, we can then proceed to next step.
+
+#### 8. Promote the release
+
+Create the final git tag:
+```sh
+$ git checkout branch-1.X
+$ export GPG_TTY=$(tty)
+$ git tag -u [email protected] v1.X.0 -m 'Release v1.X.0'
+$ git push origin v1.X.0
+```
+
+Publish the release package:
+```sh
+# Create or verify a user account in the npm registry
+$ npm adduser
+
+Username: foobar
+Password: ********
+Email: (this IS public) [email protected]
+
+# Publish the package to the npm registry
+$ npm publish
+
+# If you don't have permission to publish `pulsar-client` to the npm registry,
+# ask other committers to grant that permission.
+```
+
+Promote the artifacts on the release location (need PMC permissions):
+```sh
+$ svn mv -m 'Release Pulsar Node.js client 1.X.0' \
+
https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-candidate-1
\
+
https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-node/pulsar-client-node-1.X.0
+
+# Remove the old releases (if any)
+# We only need the latest release there, older releases are available through
the Apache archive
+$ svn rm -m 'Remove the old release' \
+
https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-node/pulsar-client-node-1.Y.0
+```
+
+#### 9. Update release notes
+
+Add the release notes there:
+https://github.com/apache/pulsar-client-node/releases
+
+#### 10. Announce the release
+
+Once the release artifact is available in the npm registry, we need to
announce the release.
+
+Send an email on these lines:
+```
+To: [email protected], [email protected], [email protected]
+Subject: [ANNOUNCE] Apache Pulsar Node.js client 1.X.0 released
+
+The Apache Pulsar team is proud to announce Apache Pulsar Node.js client
version 1.X.0.
+
+Pulsar is a highly scalable, low latency messaging platform running on
+commodity hardware. It provides simple pub-sub semantics over topics,
+guaranteed at-least-once delivery of messages, automatic cursor management for
+subscribers, and cross-datacenter replication.
+
+For Pulsar Node.js client release details and downloads, visit:
+https://www.npmjs.com/package/pulsar-client
+
+Release Notes are at:
+https://github.com/apache/pulsar-client-node/releases
+
+We would like to thank the contributors that made the release possible.
+
+Regards,
+
+The Pulsar Team
+```
