GeezerVison is showing github.com — doc,tools: switch to `@node-core/utils` · nodejs/node@f67433f
File treeExpand file treeCollapse file tree Open diff view settings Expand file treeCollapse file tree Open diff view settings Collapse file Copy file name to clipboardExpand all lines: .github/workflows/auto-start-ci.yml +3-3Lines changed: 3 additions & 3 deletions | Original file line number | Diff line number | Diff line change |
|---|
@@ -55,10 +55,10 @@ jobs: | 55 | 55 | with: | 56 | 56 | node-version: ${{ env.NODE_VERSION }} | 57 | 57 |
| 58 | | - - name: Install node-core-utils | 59 | | - run: npm install -g node-core-utils | | 58 | + - name: Install @node-core/utils | | 59 | + run: npm install -g @node-core/utils | 60 | 60 |
| 61 | | - - name: Setup node-core-utils | | 61 | + - name: Setup @node-core/utils | 62 | 62 | run: | | 63 | 63 | ncu-config set username ${{ secrets.JENKINS_USER }} | 64 | 64 | ncu-config set token "${{ secrets.GH_USER_TOKEN }}" | |
Collapse file Copy file name to clipboardExpand all lines: .github/workflows/commit-queue.yml +3-3Lines changed: 3 additions & 3 deletions | Original file line number | Diff line number | Diff line change |
|---|
@@ -74,15 +74,15 @@ jobs: | 74 | 74 | uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1 | 75 | 75 | with: | 76 | 76 | node-version: ${{ env.NODE_VERSION }} | 77 | | - - name: Install node-core-utils | 78 | | - run: npm install -g node-core-utils@latest | | 77 | + - name: Install @node-core/utils | | 78 | + run: npm install -g @node-core/utils | 79 | 79 |
| 80 | 80 | - name: Set variables | 81 | 81 | run: | | 82 | 82 | echo "REPOSITORY=$(echo ${{ github.repository }} | cut -d/ -f2)" >> $GITHUB_ENV | 83 | 83 | echo "OWNER=${{ github.repository_owner }}" >> $GITHUB_ENV | 84 | 84 |
| 85 | | - - name: Configure node-core-utils | | 85 | + - name: Configure @node-core/utils | 86 | 86 | run: | | 87 | 87 | ncu-config set branch ${GITHUB_REF_NAME} | 88 | 88 | ncu-config set upstream origin | |
Collapse file Copy file name to clipboardExpand all lines: .github/workflows/update-v8.yml +2-2Lines changed: 2 additions & 2 deletions | Original file line number | Diff line number | Diff line change |
|---|
| 33 | 33 | uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1 | 34 | 34 | with: | 35 | 35 | node-version: ${{ env.NODE_VERSION }} | 36 | | - - name: Install node-core-utils | 37 | | - run: npm install -g node-core-utils@latest | | 36 | + - name: Install @node-core/utils | | 37 | + run: npm install -g @node-core/utils | 38 | 38 | - name: Check and download new V8 version | 39 | 39 | run: | | 40 | 40 | ./tools/dep_updaters/update-v8-patch.sh > temp-output | |
Collapse file Copy file name to clipboardExpand all lines: .gitpod.yml +1-1Lines changed: 1 addition & 1 deletion | Original file line number | Diff line number | Diff line change |
|---|
| 1 | 1 | # Ref: https://github.com/gitpod-io/gitpod/issues/6283#issuecomment-1001043454 | 2 | 2 | tasks: | 3 | 3 | - init: ./configure && timeout 50m make -j16 || true | 4 | | - - init: pnpm i -g node-core-utils | | 4 | + - init: pnpm i -g @node-core/utils | 5 | 5 |
| 6 | 6 | # Ref: https://www.gitpod.io/docs/prebuilds#github-specific-configuration | 7 | 7 | github: | |
Collapse file Copy file name to clipboardExpand all lines: doc/contributing/backporting-to-release-lines.md +2-2Lines changed: 2 additions & 2 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
| 48 | 48 |
| 49 | 49 | ### Automated | 50 | 50 |
| 51 | | -1. Make sure you have [`node-core-utils`][] installed | | 51 | +1. Make sure you have [`@node-core/utils`][] installed | 52 | 52 |
| 53 | 53 | 2. Run the [`git node backport`][] command | 54 | 54 |
| @@ -132,6 +132,6 @@ original pull request with `backported-to-v20.x`. | 132 | 132 |
| 133 | 133 | [Release Plan]: https://github.com/nodejs/Release#release-plan | 134 | 134 | [Release Schedule]: https://github.com/nodejs/Release#release-schedule | | 135 | +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils | 135 | 136 | [`git node backport`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-backport | 136 | | -[`node-core-utils`]: https://github.com/nodejs/node-core-utils | 137 | 137 | [`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/build |
Collapse file Copy file name to clipboardExpand all lines: doc/contributing/collaborator-guide.md +9-8Lines changed: 9 additions & 8 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -555,22 +555,23 @@ See the [commit queue guide][commit-queue.md]. | 555 | 555 |
| 556 | 556 | ### Using `git-node` | 557 | 557 |
| 558 | | -In most cases, using [the `git-node` command][git-node] of [`node-core-utils`][] | 559 | | -is enough to land a pull request. If you discover a problem when using | 560 | | -this tool, please file an issue [to the issue tracker][node-core-utils-issues]. | | 558 | +In most cases, using [the `git-node` command][git-node] of | | 559 | +[`@node-core/utils`][] is enough to land a pull request. If you discover a | | 560 | +problem when using this tool, please file an issue | | 561 | +[to the issue tracker][node-core-utils-issues]. | 561 | 562 |
| 562 | 563 | Quick example: | 563 | 564 |
| 564 | 565 | ```bash | 565 | | -npm install -g node-core-utils | | 566 | +npm install -g @node-core/utils | 566 | 567 | git node land $PRID | 567 | 568 | ``` | 568 | 569 |
| 569 | | -To use `node-core-utils`, you will need a GitHub access token. If you do not | 570 | | -have one, `node-core-utils` will create one for you the first time you use it. | | 570 | +To use `@node-core/utils`, you will need a GitHub access token. If you do not | | 571 | +have one, `@node-core/utils` will create one for you the first time you use it. | 571 | 572 | To do this, it will ask for your GitHub password and two-factor authentication | 572 | 573 | code. If you wish to create the token yourself in advance, see | 573 | | -[the `node-core-utils` guide][node-core-utils-credentials]. | | 574 | +[the `@node-core/utils` guide][node-core-utils-credentials]. | 574 | 575 |
| 575 | 576 | ### Technical HOWTO | 576 | 577 |
| @@ -959,7 +960,7 @@ need to be attached anymore, as only important bugfixes will be included. | 959 | 960 | [TSC]: https://github.com/nodejs/TSC | 960 | 961 | [`--pending-deprecation`]: ../api/cli.md#--pending-deprecation | 961 | 962 | [`--throw-deprecation`]: ../api/cli.md#--throw-deprecation | 962 | | -[`node-core-utils`]: https://github.com/nodejs/node-core-utils | | 963 | +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils | 963 | 964 | [backporting guide]: backporting-to-release-lines.md | 964 | 965 | [commit message guidelines]: pull-requests.md#commit-message-guidelines | 965 | 966 | [commit-example]: https://github.com/nodejs/node/commit/b636ba8186 | |
Collapse file Copy file name to clipboardExpand all lines: doc/contributing/commit-queue.md +3-3Lines changed: 3 additions & 3 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -7,8 +7,8 @@ _tl;dr: You can land pull requests by adding the `commit-queue` label to it._ | 7 | 7 | Commit Queue is an experimental feature for the project which simplifies the | 8 | 8 | landing process by automating it via GitHub Actions. With it, collaborators can | 9 | 9 | land pull requests by adding the `commit-queue` label to a PR. All | 10 | | -checks will run via node-core-utils, and if the pull request is ready to land, | 11 | | -the Action will rebase it and push to `main`. | | 10 | +checks will run via `@node-core/utils`, and if the pull request is ready to | | 11 | +land, the Action will rebase it and push to `main`. | 12 | 12 |
| 13 | 13 | This document gives an overview of how the Commit Queue works, as well as | 14 | 14 | implementation details, reasoning for design choices, and current limitations. | @@ -76,7 +76,7 @@ reasons: | 76 | 76 | commit, meaning we wouldn't be able to use it for already opened PRs | 77 | 77 | without rebasing them first. | 78 | 78 |
| 79 | | -`node-core-utils` is configured with a personal token and | | 79 | +`@node-core/utils` is configured with a personal token and | 80 | 80 | a Jenkins token from | 81 | 81 | [@nodejs-github-bot](https://github.com/nodejs/github-bot). | 82 | 82 | `octokit/graphql-action` is used to fetch all pull requests with the | |
Collapse file Copy file name to clipboardExpand all lines: doc/contributing/maintaining/maintaining-V8.md +3-3Lines changed: 3 additions & 3 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -122,7 +122,7 @@ some manual steps and is recommended. | 122 | 122 |
| 123 | 123 | Here are the steps for the bug mentioned above: | 124 | 124 |
| 125 | | -1. Install `git-node` by installing [`node-core-utils`][]. | | 125 | +1. Install `git-node` by installing [`@node-core/utils`][]. | 126 | 126 | 2. Install the prerequisites for [`git-node-v8`][]. | 127 | 127 | 3. Find the commit hash linked-to in the issue (in this case a51f429). | 128 | 128 | 4. Checkout a branch off the appropriate _vY.x-staging_ branch (e.g. | @@ -277,7 +277,7 @@ that Node.js may be floating (or else cause a merge conflict). | 277 | 277 |
| 278 | 278 | #### Applying minor updates with `git-node` (recommended) | 279 | 279 |
| 280 | | -1. Install [`git-node`][] by installing [`node-core-utils`][]. | | 280 | +1. Install [`git-node`][] by installing [`@node-core/utils`][]. | 281 | 281 | 2. Install the prerequisites for [`git-node-v8`][]. | 282 | 282 | 3. Run `git node v8 minor` to apply a minor update. | 283 | 283 |
| @@ -384,8 +384,8 @@ This would require some tooling to: | 384 | 384 | [V8MergingPatching]: https://v8.dev/docs/merge-patch | 385 | 385 | [V8TemplateMergeRequest]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20merge%20request | 386 | 386 | [V8TemplateUpstreamBug]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20upstream%20bug | | 387 | +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils#Install | 387 | 388 | [`git-node-v8-backport`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-backport-sha | 388 | 389 | [`git-node-v8-minor`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-minor | 389 | 390 | [`git-node-v8`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8 | 390 | 391 | [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8 | 391 | | -[`node-core-utils`]: https://github.com/nodejs/node-core-utils#Install |
Collapse file Copy file name to clipboardExpand all lines: doc/contributing/releases.md +5-5Lines changed: 5 additions & 5 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -563,7 +563,7 @@ ecosystem. | 563 | 563 | Use `ncu-ci` to compare `vx.x` run (10) and proposal branch (11) | 564 | 564 |
| 565 | 565 | ```bash | 566 | | -npm i -g node-core-utils | | 566 | +npm i -g @node-core/utils | 567 | 567 | ncu-ci citgm 10 11 | 568 | 568 | ``` | 569 | 569 |
| @@ -1052,7 +1052,7 @@ _In whatever form you do this..._ | 1052 | 1052 | ### Marking a release line as LTS | 1053 | 1053 |
| 1054 | 1054 | The process of marking a release line as LTS has been automated using | 1055 | | -[node-core-utils](https://github.com/nodejs/node-core-utils). | | 1055 | +[`@node-core/utils`](https://github.com/nodejs/node-core-utils). | 1056 | 1056 |
| 1057 | 1057 | Start by checking out the staging branch for the release line that is going to | 1058 | 1058 | be marked as LTS, e.g: | @@ -1061,10 +1061,10 @@ be marked as LTS, e.g: | 1061 | 1061 | git checkout v1.x-staging | 1062 | 1062 | ``` | 1063 | 1063 |
| 1064 | | -Next, make sure you have **node-core-utils** installed: | | 1064 | +Next, make sure you have **`@node-core/utils`** installed: | 1065 | 1065 |
| 1066 | 1066 | ```bash | 1067 | | -npm i -g node-core-utils | | 1067 | +npm i -g @node-core/utils | 1068 | 1068 | ``` | 1069 | 1069 |
| 1070 | 1070 | Run the prepare LTS release command: | @@ -1110,7 +1110,7 @@ current LTS codename in its release line changelog file. | 1110 | 1110 |
| 1111 | 1111 | The `test/parallel/test-process-release.js` file might also need to be updated. | 1112 | 1112 |
| 1113 | | -In case you can not run the automated `node-core-utils` command and you are | | 1113 | +In case you can not run the automated `@node-core/utils` command and you are | 1114 | 1114 | currently running these steps manually it's a good idea to refer to previous | 1115 | 1115 | LTS proposal PRs and make sure all required changes are covered. | 1116 | 1116 |
| |
Collapse file Copy file name to clipboardExpand all lines: onboarding.md +3-3Lines changed: 3 additions & 3 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -10,7 +10,7 @@ onboarding session. | 10 | 10 | possible to add them to the organization if they are not using two-factor | 11 | 11 | authentication. If they cannot receive SMS messages from GitHub, try | 12 | 12 | [using a TOTP mobile app][]. | 13 | | -* Suggest the new Collaborator install [`node-core-utils`][] and | | 13 | +* Suggest the new Collaborator install [`@node-core/utils`][] and | 14 | 14 | [set up the credentials][] for it. | 15 | 15 |
| 16 | 16 | ## Fifteen minutes before the onboarding session | @@ -230,7 +230,7 @@ needs to be pointed out separately during the onboarding. | 230 | 230 | request. | 231 | 231 | * Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` | 232 | 232 | metadata. | 233 | | - * [`node-core-utils`][] automates the generation of metadata and the landing | | 233 | + * [`@node-core/utils`][] automates the generation of metadata and the landing | 234 | 234 | process. See the documentation of [`git-node`][]. | 235 | 235 | * [`core-validate-commit`][] automates the validation of commit messages. | 236 | 236 | This will be run during `git node land --final` of the [`git-node`][] | @@ -260,10 +260,10 @@ needs to be pointed out separately during the onboarding. | 260 | 260 | [Labels]: doc/contributing/collaborator-guide.md#labels | 261 | 261 | [Landing pull requests]: doc/contributing/collaborator-guide.md#landing-pull-requests | 262 | 262 | [Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/ | | 263 | +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils | 263 | 264 | [`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests | 264 | 265 | [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit | 265 | 266 | [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md | 266 | | -[`node-core-utils`]: https://github.com/nodejs/node-core-utils | 267 | 267 | [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials | 268 | 268 | [static-analysis]: doc/contributing/static-analysis.md | 269 | 269 | [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/ | |
|