Skip to content

Commit

Permalink
chore: link to 3.x release notes on 3.x branch, other small changes (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
trentm authored Sep 8, 2023
1 parent 4abc31a commit 94197e3
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ jobs:
- name: npm publish
run: |-
echo "//registry.npmjs.org/:_authToken=${{ env.NPMJS_TOKEN }}" > .npmrc
# Publishing without a '--tag=...' will do the right thing: "latest"
# if this is a non-pre-release, no tag if this is a pre-release.
npm publish --otp=${{ env.TOTP_CODE }}
- if: always()
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
push:
branches:
- main
- 3.x
paths-ignore:
- '**/*.md'
- '**/*.asciidoc'
Expand All @@ -15,7 +14,6 @@ on:
pull_request:
branches:
- main
- 3.x
paths-ignore:
- '**/*.md'
- '**/*.asciidoc'
Expand Down
6 changes: 5 additions & 1 deletion CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@ See the <<upgrade-to-v4>> guide.
[[release-notes-3.x]]
=== Node.js Agent version 3.x
// 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>
NOTE: "3.x" releases are now maintenance releases.
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]
for the most recent 3.x releases. The 3.x branch will be maintained until
2024-03-07 (6 months after the 4.0.0 release).
[[release-notes-3.49.1]]
==== 3.49.1 - 2023/08/09
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ for the current *experimental* support.
The full [Node.js APM agent documentation is here](https://www.elastic.co/guide/en/apm/agent/nodejs/current/intro.html).
Some important links:
- [Release notes](https://www.elastic.co/guide/en/apm/agent/nodejs/current/release-notes.html)
- [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.
- [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).
- [Configuration options](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html) is a full configuration reference.
Expand All @@ -98,8 +99,7 @@ Some important links:
The following git branches are active:
- The ["main" branch](https://github.com/elastic/apm-agent-nodejs/tree/main) is being used for **4.x releases**.
- 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.
- 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.
## Contributing
Expand Down
4 changes: 2 additions & 2 deletions lib/parsers.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ function getContextFromRequest(req, conf, type) {
* Extract appropriate `{transaction,error}.context.response` from an HTTP
* response object. This handles header redaction according to the agent config.
*
* @param {Object} res - Typically `res` is a Node.js `http.OutgoingMessage`
* (https://nodejs.org/api/http.html#class-httpoutgoingmessage).
* @param {Object} res - Typically `res` is a Node.js `http.ServerResponse`
* (https://nodejs.org/api/http.html#class-httpserverresponse).
* However, some cases (e.g. Lambda and Azure Functions instrumentation)
* create a pseudo-res object that matches well enough for this function.
* Some relevant fields: (TODO: document all used fields)
Expand Down

0 comments on commit 94197e3

Please sign in to comment.