From a34d58926afa6e827eef491c40ad11b1eb6e1d44 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Thu, 5 May 2022 12:39:29 -0700 Subject: [PATCH] 3.33.0 (#2676) --- CHANGELOG.asciidoc | 15 ++++++++++++--- CONTRIBUTING.md | 34 +++++----------------------------- docs/upgrading.asciidoc | 1 + package.json | 2 +- 4 files changed, 19 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index f05a390889..f4582a8685 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -28,10 +28,9 @@ Notes: [[release-notes-3.x]] === Node.js Agent version 3.x -==== Unreleased -[float] -===== Breaking changes +[[release-notes-3.33.0]] +==== 3.33.0 2022/05/05 [float] ===== Features @@ -57,6 +56,16 @@ types, because it is only expected to be useful for coming OTel Bridge work. proxy, which can throw `ERR_HTTP2_SOCKET_UNBOUND` after the session is destroyed. ({issues}2670[#2670]) +[float] +===== Chores + +- The release process is slightly changed. CI (Jenkins) now handles `npm + publish ...` when a tag is pushed. ({pull}2667[#2667]) + +- Pulled the `traceparent` NPM module into a local module and replaced the + `random-poly-fill` module with the built in `require('crypto').randomFillSync` + function call ({pull}2669[#2669]) + [[release-notes-3.32.0]] ==== 3.32.0 2022/04/27 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23a753127e..a804b49ab0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -184,41 +184,17 @@ If you have access to make releases, the process is as follows: - the EOL table in `docs/upgrading.asciidoc`, if this is a major or minor release. EOL is 18 months after release date. 1. Ensure PR checks pass, then merge to main. -1. Publish to npm with `npm publish`. - This must be done *before* the release tag is pushed, because the automated - release process is triggered by the tag push and (the opbeans - bump-version.sh release step) depends on the new version having been - published to npm. 1. Working on the elastic repo now (not a fork), tag the merged-to-main commit with `git tag vx.y.x && git push origin vx.y.z`. For example: `git tag v1.2.3 && git push origin v1.2.3`. + (The Jenkins CI "Release" stage will handle `npm publish ...`ing the new + package version. See the appropriate [apm-ci tag build for this repo](https://apm-ci.elastic.co/job/apm-agent-nodejs/job/apm-agent-nodejs-mbp/view/tags/).) 1. Reset the latest major branch (currently `3.x`) to point to the current main, e.g. `git branch -f 3.x main && git push origin 3.x` ### Past major -1. Be sure you have checked out the branch associated with the major you wish - to release and have pulled latest changes, e.g. `2.x`. -1. Make a PR titled "x.y.z" (the new version) which updates: - - the version in `package.json`, - - "CHANGELOG.asciidoc": Add missing changelog entries, if any. Then change - the "Unreleased" section title to: - ``` - [[release-notes-x.y.z]] - ==== x.y.z - YYYY/MM/DD - ``` - - the EOL table in `docs/upgrading.asciidoc`, if this is a major or minor - release. EOL is 18 months after release date. -1. Ensure PR checks pass, then merge to main. -1. Publish to npm with `npm publish --tag=2x`. - **It is important to include that `--tag=2x`.** - This must be done *before* the release tag is pushed, because the automated - release process is triggered by the tag push and (the opbeans - bump-version.sh release step) depends on the new version having been - published to npm. -1. Working on the elastic repo now (not a fork), tag the merged-to-main commit - with `git tag vx.y.x && git push origin vx.y.z`. For example: `git tag - v1.2.3 && git push origin v1.2.3`. -1. Make a PR against `main` containing the updates to `CHANGELOG.asciidoc` so - that `main` always contain information about all releases +This is not currently supported. Until [this issue](#2668) is resolved one +**must not** push a "vX.Y.Z" version tag to the repository on GitHub that is +for a version other than the current major. diff --git a/docs/upgrading.asciidoc b/docs/upgrading.asciidoc index c2fd047773..ef766b84e8 100644 --- a/docs/upgrading.asciidoc +++ b/docs/upgrading.asciidoc @@ -36,6 +36,7 @@ The table below is a simplified description of this policy. [options="header"] |==== |Agent version |EOL Date |Maintained until +|3.33.x |2023-11-05 |3.34.0 |3.32.x |2023-10-27 |3.33.0 |3.31.x |2023-09-23 |3.32.0 |3.30.x |2023-09-10 |3.31.0 diff --git a/package.json b/package.json index 565377f91f..e5463878a2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "elastic-apm-node", - "version": "3.32.0", + "version": "3.33.0", "description": "The official Elastic APM agent for Node.js", "main": "index.js", "types": "index.d.ts",