Skip to content

Commit 683e6d0

Browse files
trentmPeterEinberger
authored andcommitted
chore: note a relevant typescript v5 feature; correct some CI links (elastic#3243)
* typescript note for new v5 thing that is related * update for release process being in GH Actions CI now * renumber; note the relevant CI job for updating the 'current' published docs
1 parent ed99219 commit 683e6d0

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ If you have access to make releases, the process is as follows:
173173

174174
1. Be sure you have checked out the `main` branch and have pulled latest
175175
changes.
176-
1. Make a PR titled "x.y.z" (the new version) which updates:
176+
2. Make a PR titled "x.y.z" (the new version) which updates:
177177
- the version in `package.json`,
178178
- the version in `package-lock.json` (by running `npm install`),
179179
- "CHANGELOG.asciidoc": Add missing changelog entries, if any. Then change
@@ -182,15 +182,18 @@ If you have access to make releases, the process is as follows:
182182
[[release-notes-x.y.z]]
183183
==== x.y.z - YYYY/MM/DD
184184
```
185-
1. Ensure PR checks pass, then merge to main.
186-
1. Working on the elastic repo now (not a fork), tag the merged-to-main commit
185+
3. Ensure PR checks pass, then merge to main.
186+
4. Working on the elastic repo now (not a fork), tag the merged-to-main commit
187187
with `git tag vx.y.x && git push origin vx.y.z`. For example: `git tag
188188
v1.2.3 && git push origin v1.2.3`.
189-
(The Jenkins CI "Release" stage will handle `npm publish ...`ing the new
190-
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/).)
191-
1. Reset the latest major branch (currently `3.x`) to point to the current
192-
main, e.g. `git branch -f 3.x main && git push origin 3.x`
193-
1. For major releases, [create an issue](https://github.com/elastic/website-requests/issues/new) to request an update of the [EOL table](https://www.elastic.co/support/eol).
189+
(The GitHub Actions CI "release" workflow will handle all the release
190+
steps -- including the `npm publish`. See the appropriate run at:
191+
https://github.com/elastic/apm-agent-nodejs/actions/workflows/release.yml)
192+
5. Reset the latest major branch (currently `3.x`) to point to the current
193+
main, e.g. `git branch -f 3.x main && git push origin 3.x`.
194+
(The periodic [docs CI job](https://elasticsearch-ci.elastic.co/view/Docs/job/elastic+docs+master+build/)
195+
uses this branch to update the [published docs](https://www.elastic.co/guide/en/apm/agent/nodejs/current/release-notes-3.x.html).)
196+
6. For major releases, [create an issue](https://github.com/elastic/website-requests/issues/new) to request an update of the [EOL table](https://www.elastic.co/support/eol).
194197
195198
### Past major
196199

docs/set-up.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,9 @@ Or with something like this:
217217
import apm from 'elastic-apm-node/start'; apm; // Ensure import is kept for its side-effect.
218218
----
219219

220+
TypeScript 5.0 https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#verbatimmodulesyntax[introduced a `--verbatimModuleSyntax`]
221+
option that avoids this elision.
222+
220223

221224
[[start-bundlers]]
222225
===== Bundlers and APM

0 commit comments

Comments
 (0)