From 3922d181b8496129e02b1c16013e33ada47cdd79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Zasso?= Date: Mon, 25 Sep 2023 13:48:03 +0200 Subject: [PATCH] doc,tools: switch to `@node-core/utils` Refs: https://github.com/nodejs/node-core-utils/releases/tag/v4.0.0 PR-URL: https://github.com/nodejs/node/pull/49851 Refs: https://github.com/nodejs/node-core-utils/pull/700 Reviewed-By: Antoine du Hamel Reviewed-By: Marco Ippolito Reviewed-By: Yagiz Nizipli --- .github/workflows/auto-start-ci.yml | 6 +++--- .github/workflows/commit-queue.yml | 6 +++--- .github/workflows/update-v8.yml | 4 ++-- .gitpod.yml | 2 +- .../backporting-to-release-lines.md | 4 ++-- doc/contributing/collaborator-guide.md | 17 +++++++++-------- doc/contributing/commit-queue.md | 6 +++--- doc/contributing/maintaining/maintaining-V8.md | 6 +++--- doc/contributing/releases.md | 10 +++++----- onboarding.md | 6 +++--- 10 files changed, 34 insertions(+), 33 deletions(-) diff --git a/.github/workflows/auto-start-ci.yml b/.github/workflows/auto-start-ci.yml index 6a45b2d692b94e..ecc7f6d2e7dbe3 100644 --- a/.github/workflows/auto-start-ci.yml +++ b/.github/workflows/auto-start-ci.yml @@ -55,10 +55,10 @@ jobs: with: node-version: ${{ env.NODE_VERSION }} - - name: Install node-core-utils - run: npm install -g node-core-utils + - name: Install @node-core/utils + run: npm install -g @node-core/utils - - name: Setup node-core-utils + - name: Setup @node-core/utils run: | ncu-config set username ${{ secrets.JENKINS_USER }} ncu-config set token "${{ secrets.GH_USER_TOKEN }}" diff --git a/.github/workflows/commit-queue.yml b/.github/workflows/commit-queue.yml index 8cf3978c3f23ef..322d483d6fff7a 100644 --- a/.github/workflows/commit-queue.yml +++ b/.github/workflows/commit-queue.yml @@ -74,15 +74,15 @@ jobs: uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1 with: node-version: ${{ env.NODE_VERSION }} - - name: Install node-core-utils - run: npm install -g node-core-utils@latest + - name: Install @node-core/utils + run: npm install -g @node-core/utils - name: Set variables run: | echo "REPOSITORY=$(echo ${{ github.repository }} | cut -d/ -f2)" >> $GITHUB_ENV echo "OWNER=${{ github.repository_owner }}" >> $GITHUB_ENV - - name: Configure node-core-utils + - name: Configure @node-core/utils run: | ncu-config set branch ${GITHUB_REF_NAME} ncu-config set upstream origin diff --git a/.github/workflows/update-v8.yml b/.github/workflows/update-v8.yml index fb123a5b069a72..1a6c87aa528d33 100644 --- a/.github/workflows/update-v8.yml +++ b/.github/workflows/update-v8.yml @@ -33,8 +33,8 @@ jobs: uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1 with: node-version: ${{ env.NODE_VERSION }} - - name: Install node-core-utils - run: npm install -g node-core-utils@latest + - name: Install @node-core/utils + run: npm install -g @node-core/utils - name: Check and download new V8 version run: | ./tools/dep_updaters/update-v8-patch.sh > temp-output diff --git a/.gitpod.yml b/.gitpod.yml index b674e800f4c015..1a56acf40f1746 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,7 +1,7 @@ # Ref: https://github.com/gitpod-io/gitpod/issues/6283#issuecomment-1001043454 tasks: - init: ./configure && timeout 50m make -j16 || true - - init: pnpm i -g node-core-utils + - init: pnpm i -g @node-core/utils # Ref: https://www.gitpod.io/docs/prebuilds#github-specific-configuration github: diff --git a/doc/contributing/backporting-to-release-lines.md b/doc/contributing/backporting-to-release-lines.md index 58f6a54192e12a..851e4e255442d1 100644 --- a/doc/contributing/backporting-to-release-lines.md +++ b/doc/contributing/backporting-to-release-lines.md @@ -48,7 +48,7 @@ line. ### Automated -1. Make sure you have [`node-core-utils`][] installed +1. Make sure you have [`@node-core/utils`][] installed 2. Run the [`git node backport`][] command @@ -132,6 +132,6 @@ original pull request with `backported-to-v20.x`. [Release Plan]: https://github.com/nodejs/Release#release-plan [Release Schedule]: https://github.com/nodejs/Release#release-schedule +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils [`git node backport`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-backport -[`node-core-utils`]: https://github.com/nodejs/node-core-utils [`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/build diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index a4218acc7d4fd0..2ecf14a082dc3b 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -555,22 +555,23 @@ See the [commit queue guide][commit-queue.md]. ### Using `git-node` -In most cases, using [the `git-node` command][git-node] of [`node-core-utils`][] -is enough to land a pull request. If you discover a problem when using -this tool, please file an issue [to the issue tracker][node-core-utils-issues]. +In most cases, using [the `git-node` command][git-node] of +[`@node-core/utils`][] is enough to land a pull request. If you discover a +problem when using this tool, please file an issue +[to the issue tracker][node-core-utils-issues]. Quick example: ```bash -npm install -g node-core-utils +npm install -g @node-core/utils git node land $PRID ``` -To use `node-core-utils`, you will need a GitHub access token. If you do not -have one, `node-core-utils` will create one for you the first time you use it. +To use `@node-core/utils`, you will need a GitHub access token. If you do not +have one, `@node-core/utils` will create one for you the first time you use it. To do this, it will ask for your GitHub password and two-factor authentication code. If you wish to create the token yourself in advance, see -[the `node-core-utils` guide][node-core-utils-credentials]. +[the `@node-core/utils` guide][node-core-utils-credentials]. ### Technical HOWTO @@ -959,7 +960,7 @@ need to be attached anymore, as only important bugfixes will be included. [TSC]: https://github.com/nodejs/TSC [`--pending-deprecation`]: ../api/cli.md#--pending-deprecation [`--throw-deprecation`]: ../api/cli.md#--throw-deprecation -[`node-core-utils`]: https://github.com/nodejs/node-core-utils +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils [backporting guide]: backporting-to-release-lines.md [commit message guidelines]: pull-requests.md#commit-message-guidelines [commit-example]: https://github.com/nodejs/node/commit/b636ba8186 diff --git a/doc/contributing/commit-queue.md b/doc/contributing/commit-queue.md index 4730d0889e99aa..cece9ea84e94f8 100644 --- a/doc/contributing/commit-queue.md +++ b/doc/contributing/commit-queue.md @@ -7,8 +7,8 @@ _tl;dr: You can land pull requests by adding the `commit-queue` label to it._ Commit Queue is an experimental feature for the project which simplifies the landing process by automating it via GitHub Actions. With it, collaborators can land pull requests by adding the `commit-queue` label to a PR. All -checks will run via node-core-utils, and if the pull request is ready to land, -the Action will rebase it and push to `main`. +checks will run via `@node-core/utils`, and if the pull request is ready to +land, the Action will rebase it and push to `main`. This document gives an overview of how the Commit Queue works, as well as implementation details, reasoning for design choices, and current limitations. @@ -76,7 +76,7 @@ reasons: commit, meaning we wouldn't be able to use it for already opened PRs without rebasing them first. -`node-core-utils` is configured with a personal token and +`@node-core/utils` is configured with a personal token and a Jenkins token from [@nodejs-github-bot](https://github.com/nodejs/github-bot). `octokit/graphql-action` is used to fetch all pull requests with the diff --git a/doc/contributing/maintaining/maintaining-V8.md b/doc/contributing/maintaining/maintaining-V8.md index 0fe9b393fc0f15..740af7f228f694 100644 --- a/doc/contributing/maintaining/maintaining-V8.md +++ b/doc/contributing/maintaining/maintaining-V8.md @@ -122,7 +122,7 @@ some manual steps and is recommended. Here are the steps for the bug mentioned above: -1. Install `git-node` by installing [`node-core-utils`][]. +1. Install `git-node` by installing [`@node-core/utils`][]. 2. Install the prerequisites for [`git-node-v8`][]. 3. Find the commit hash linked-to in the issue (in this case a51f429). 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). #### Applying minor updates with `git-node` (recommended) -1. Install [`git-node`][] by installing [`node-core-utils`][]. +1. Install [`git-node`][] by installing [`@node-core/utils`][]. 2. Install the prerequisites for [`git-node-v8`][]. 3. Run `git node v8 minor` to apply a minor update. @@ -384,8 +384,8 @@ This would require some tooling to: [V8MergingPatching]: https://v8.dev/docs/merge-patch [V8TemplateMergeRequest]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20merge%20request [V8TemplateUpstreamBug]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20upstream%20bug +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils#Install [`git-node-v8-backport`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-backport-sha [`git-node-v8-minor`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-minor [`git-node-v8`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8 [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8 -[`node-core-utils`]: https://github.com/nodejs/node-core-utils#Install diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 8b4bdb3c487104..bf34bff850c678 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -563,7 +563,7 @@ ecosystem. Use `ncu-ci` to compare `vx.x` run (10) and proposal branch (11) ```bash -npm i -g node-core-utils +npm i -g @node-core/utils ncu-ci citgm 10 11 ``` @@ -1052,7 +1052,7 @@ _In whatever form you do this..._ ### Marking a release line as LTS The process of marking a release line as LTS has been automated using -[node-core-utils](https://github.com/nodejs/node-core-utils). +[`@node-core/utils`](https://github.com/nodejs/node-core-utils). Start by checking out the staging branch for the release line that is going to be marked as LTS, e.g: @@ -1061,10 +1061,10 @@ be marked as LTS, e.g: git checkout v1.x-staging ``` -Next, make sure you have **node-core-utils** installed: +Next, make sure you have **`@node-core/utils`** installed: ```bash -npm i -g node-core-utils +npm i -g @node-core/utils ``` Run the prepare LTS release command: @@ -1110,7 +1110,7 @@ current LTS codename in its release line changelog file. The `test/parallel/test-process-release.js` file might also need to be updated. -In case you can not run the automated `node-core-utils` command and you are +In case you can not run the automated `@node-core/utils` command and you are currently running these steps manually it's a good idea to refer to previous LTS proposal PRs and make sure all required changes are covered. diff --git a/onboarding.md b/onboarding.md index 1e912f0c8a4379..be393a64f3fc67 100644 --- a/onboarding.md +++ b/onboarding.md @@ -10,7 +10,7 @@ onboarding session. possible to add them to the organization if they are not using two-factor authentication. If they cannot receive SMS messages from GitHub, try [using a TOTP mobile app][]. -* Suggest the new Collaborator install [`node-core-utils`][] and +* Suggest the new Collaborator install [`@node-core/utils`][] and [set up the credentials][] for it. ## Fifteen minutes before the onboarding session @@ -230,7 +230,7 @@ needs to be pointed out separately during the onboarding. request. * Be sure to add the `PR-URL: ` and appropriate `Reviewed-By:` metadata. - * [`node-core-utils`][] automates the generation of metadata and the landing + * [`@node-core/utils`][] automates the generation of metadata and the landing process. See the documentation of [`git-node`][]. * [`core-validate-commit`][] automates the validation of commit messages. 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. [Labels]: doc/contributing/collaborator-guide.md#labels [Landing pull requests]: doc/contributing/collaborator-guide.md#landing-pull-requests [Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/ +[`@node-core/utils`]: https://github.com/nodejs/node-core-utils [`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md -[`node-core-utils`]: https://github.com/nodejs/node-core-utils [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials [static-analysis]: doc/contributing/static-analysis.md [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/