Skip to content

Commit 94197e3

Browse files
authored
chore: link to 3.x release notes on 3.x branch, other small changes (#3617)
1 parent 4abc31a commit 94197e3

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

.github/workflows/release.yml

-2
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,6 @@ jobs:
6969
- name: npm publish
7070
run: |-
7171
echo "//registry.npmjs.org/:_authToken=${{ env.NPMJS_TOKEN }}" > .npmrc
72-
# Publishing without a '--tag=...' will do the right thing: "latest"
73-
# if this is a non-pre-release, no tag if this is a pre-release.
7472
npm publish --otp=${{ env.TOTP_CODE }}
7573
7674
- if: always()

.github/workflows/test.yml

-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ on:
66
push:
77
branches:
88
- main
9-
- 3.x
109
paths-ignore:
1110
- '**/*.md'
1211
- '**/*.asciidoc'
@@ -15,7 +14,6 @@ on:
1514
pull_request:
1615
branches:
1716
- main
18-
- 3.x
1917
paths-ignore:
2018
- '**/*.md'
2119
- '**/*.asciidoc'

CHANGELOG.asciidoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,11 @@ See the <<upgrade-to-v4>> guide.
122122
[[release-notes-3.x]]
123123
=== Node.js Agent version 3.x
124124
125-
// To see the changelog for later 3.x release, see the "3.x" branch: <https://github.com/elastic/apm-agent-nodejs/blob/3.x/CHANGELOG.asciidoc>
125+
NOTE: "3.x" releases are now maintenance releases.
126+
See https://www.elastic.co/guide/en/apm/agent/nodejs/3.x/release-notes-3.x.html[the 3.x release notes in the "3.x" branch]
127+
for the most recent 3.x releases. The 3.x branch will be maintained until
128+
2024-03-07 (6 months after the 4.0.0 release).
129+
126130
127131
[[release-notes-3.49.1]]
128132
==== 3.49.1 - 2023/08/09

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ for the current *experimental* support.
8484
The full [Node.js APM agent documentation is here](https://www.elastic.co/guide/en/apm/agent/nodejs/current/intro.html).
8585
Some important links:
8686
87+
- [Release notes](https://www.elastic.co/guide/en/apm/agent/nodejs/current/release-notes.html)
8788
- [Supported Technologies](https://www.elastic.co/guide/en/apm/agent/nodejs/current/supported-technologies.html) describes the supported Node.js versions, which modules (and version ranges) are automatically traced, and other technologies.
8889
- [Configuring the agent](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuring-the-agent.html) describes the different ways to configure the APM agent (via options to `apm.start(...)`, environment variables, or other mechanisms).
8990
- [Configuration options](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html) is a full configuration reference.
@@ -98,8 +99,7 @@ Some important links:
9899
The following git branches are active:
99100
100101
- The ["main" branch](https://github.com/elastic/apm-agent-nodejs/tree/main) is being used for **4.x releases**.
101-
- The ["3.x" branch](https://github.com/elastic/apm-agent-nodejs/tree/3.x) is being used for **3.x maintenance releases**. The 3.x line will be [supported for 6 months](https://www.elastic.co/support/eol) after the release of v4.0.0.
102-
102+
- The ["3.x" branch](https://github.com/elastic/apm-agent-nodejs/tree/3.x) is being used for **3.x maintenance releases**. The 3.x line will be [supported until 2024-03-07](https://www.elastic.co/support/eol) -- for 6 months after the release of v4.0.0.
103103
104104
## Contributing
105105

lib/parsers.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ function getContextFromRequest(req, conf, type) {
113113
* Extract appropriate `{transaction,error}.context.response` from an HTTP
114114
* response object. This handles header redaction according to the agent config.
115115
*
116-
* @param {Object} res - Typically `res` is a Node.js `http.OutgoingMessage`
117-
* (https://nodejs.org/api/http.html#class-httpoutgoingmessage).
116+
* @param {Object} res - Typically `res` is a Node.js `http.ServerResponse`
117+
* (https://nodejs.org/api/http.html#class-httpserverresponse).
118118
* However, some cases (e.g. Lambda and Azure Functions instrumentation)
119119
* create a pseudo-res object that matches well enough for this function.
120120
* Some relevant fields: (TODO: document all used fields)

0 commit comments

Comments
 (0)