8000 doc,tools: switch to `@node-core/utils` · nodejs/node@f67433f · GitHub
[go: up one dir, main page]
Skip to content

Commit f67433f

Browse files
targosruyadorno
targos
authored and
ruyadorno
committed
doc,tools: switch to @node-core/utils
Refs: https://github.com/nodejs/node-core-utils/releases/tag/v4.0.0 PR-URL: #49851 Refs: nodejs/node-core-utils#700 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
1 parent 96874e8 commit f67433f

File tree

10 files changed

+34
-33
lines changed
  • < 8000 div style="width:100%;display:flex">
    .github/workflows
  • .gitpod.yml
  • doc/contributing
  • onboarding.md

    • 10 files changed

    +34
    -33
    lines changed

    ‎.github/workflows/auto-start-ci.yml‎

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -55,10 +55,10 @@ jobs:
    5555
    with:
    5656
    node-version: ${{ env.NODE_VERSION }}
    5757

    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
    6060

    61-
    - name: Setup node-core-utils
    61+
    - name: Setup @node-core/utils
    6262
    run: |
    6363
    ncu-config set username ${{ secrets.JENKINS_USER }}
    6464
    ncu-config set token "${{ secrets.GH_USER_TOKEN }}"

    ‎.github/workflows/commit-queue.yml‎

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -74,15 +74,15 @@ jobs:
    7474
    uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
    7575
    with:
    7676
    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
    7979

    8080
    - name: Set variables
    8181
    run: |
    8282
    echo "REPOSITORY=$(echo ${{ github.repository }} | cut -d/ -f2)" >> $GITHUB_ENV
    8383
    echo "OWNER=${{ github.repository_owner }}" >> $GITHUB_ENV
    8484
    85-
    - name: Configure node-core-utils
    85+
    - name: Configure @node-core/utils
    8686
    run: |
    8787
    ncu-config set branch ${GITHUB_REF_NAME}
    8888
    ncu-config set upstream origin

    ‎.github/workflows/update-v8.yml‎

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -33,8 +33,8 @@ jobs:
    3333
    uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
    3434
    with:
    3535
    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
    3838
    - name: Check and download new V8 version
    3939
    run: |
    4040
    ./tools/dep_updaters/update-v8-patch.sh > temp-output

    ‎.gitpod.yml‎

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -1,7 +1,7 @@
    11
    # Ref: https://github.com/gitpod-io/gitpod/issues/6283#issuecomment-1001043454
    22
    tasks:
    33
    - init: ./configure && timeout 50m make -j16 || true
    4-
    - init: pnpm i -g node-core-utils
    4+
    - init: pnpm i -g @node-core/utils
    55

    66
    # Ref: https://www.gitpod.io/docs/prebuilds#github-specific-configuration
    77
    github:

    ‎doc/contributing/backporting-to-release-lines.md‎

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -48,7 +48,7 @@ line.
    4848

    4949
    ### Automated
    5050

    51-
    1. Make sure you have [`node-core-utils`][] installed
    51+
    1. Make sure you have [`@node-core/utils`][] installed
    5252

    5353
    2. Run the [`git node backport`][] command
    5454

    @@ -132,6 +132,6 @@ original pull request with `backported-to-v20.x`.
    132132

    133133
    [Release Plan]: https://github.com/nodejs/Release#release-plan
    134134
    [Release Schedule]: https://github.com/nodejs/Release#release-schedule
    135+
    [`@node-core/utils`]: https://github.com/nodejs/node-core-utils
    135136
    [`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
    137137
    [`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/build

    ‎doc/contributing/collaborator-guide.md‎

    Lines changed: 9 additions & 8 deletions
    Original file line numberDiff line numberDiff line change
    @@ -555,22 +555,23 @@ See the [commit queue guide][commit-queue.md].
    555555

    556556
    ### Using `git-node`
    557557

    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].
    561562

    562563
    Quick example:
    563564

    564565
    ```bash
    565-
    npm install -g node-core-utils
    566+
    npm install -g @node-core/utils
    566567
    git node land $PRID
    567568
    ```
    568569

    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.
    571572
    To do this, it will ask for your GitHub password and two-factor authentication
    572573
    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].
    574575

    575576
    ### Technical HOWTO
    576577

    @@ -959,7 +960,7 @@ need to be attached anymore, as only important bugfixes will be included.
    959960
    [TSC]: https://github.com/nodejs/TSC
    960961
    [`--pending-deprecation`]: ../api/cli.md#--pending-deprecation
    961962
    [`--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
    963964
    [backporting guide]: backporting-to-release-lines.md
    964965
    [commit message guidelines]: pull-requests.md#commit-message-guidelines
    965966
    [commit-example]: https://github.com/nodejs/node/commit/b636ba8186

    ‎doc/contributing/commit-queue.md‎

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -7,8 +7,8 @@ _tl;dr: You can land pull requests by adding the `commit-queue` label to it._
    77
    Commit Queue is an experimental feature for the project which simplifies the
    88
    landing process by automating it via GitHub Actions. With it, collaborators can
    99
    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`.
    1212

    1313
    This document gives an overview of how the Commit Queue works, as well as
    1414
    implementation details, reasoning for design choices, and current limitations.
    @@ -76,7 +76,7 @@ reasons:
    7676
    commit, meaning we wouldn't be able to use it for already opened PRs
    7777
    without rebasing them first.
    7878

    79-
    `node-core-utils` is configured with a personal token and
    79+
    `@node-core/utils` is configured with a personal token and
    8080
    a Jenkins token from
    8181
    [@nodejs-github-bot](https://github.com/nodejs/github-bot).
    8282
    `octokit/graphql-action` is used to fetch all pull requests with the

    ‎doc/contributing/maintaining/maintaining-V8.md‎

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -122,7 +122,7 @@ some manual steps and is recommended.
    122122

    123123
    Here are the steps for the bug mentioned above:
    124124

    125-
    1. Install `git-node` by installing [`node-core-utils`][].
    125+
    1. Install `git-node` by installing [`@node-core/utils`][].
    126126
    2. Install the prerequisites for [`git-node-v8`][].
    127127
    3. Find the commit hash linked-to in the issue (in this case a51f429).
    128128
    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).
    277277

    278278
    #### Applying minor updates with `git-node` (recommended)
    279279

    280-
    1. Install [`git-node`][] by installing [`node-core-utils`][].
    280+
    1. Install [`git-node`][] by installing [`@node-core/utils`][].
    281281
    2. Install the prerequisites for [`git-node-v8`][].
    282282
    3. Run `git node v8 minor` to apply a minor update.
    283283

    @@ -384,8 +384,8 @@ This would require some tooling to:
    384384
    [V8MergingPatching]: https://v8.dev/docs/merge-patch
    385385
    [V8TemplateMergeRequest]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20merge%20request
    386386
    [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
    387388
    [`git-node-v8-backport`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-backport-sha
    388389
    [`git-node-v8-minor`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-v8-minor
    389390
    [`git-node-v8`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8
    390391
    [`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

    ‎doc/contributing/releases.md‎

    Lines changed: 5 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -563,7 +563,7 @@ ecosystem.
    563563
    Use `ncu-ci` to compare `vx.x` run (10) and proposal branch (11)
    564564

    565565
    ```bash
    566-
    npm i -g node-core-utils
    566+
    npm i -g @node-core/utils
    567567
    ncu-ci citgm 10 11
    568568
    ```
    569569

    @@ -1052,7 +1052,7 @@ _In whatever form you do this..._
    10521052
    ### Marking a release line as LTS
    10531053

    10541054
    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).
    10561056

    10571057
    Start by checking out the staging branch for the release line that is going to
    10581058
    be marked as LTS, e.g:
    @@ -1061,10 +1061,10 @@ be marked as LTS, e.g:
    10611061
    git checkout v1.x-staging
    10621062
    ```
    10631063

    1064-
    Next, make sure you have **node-core-utils** installed:
    1064+
    Next, make sure you have **`@node-core/utils`** installed:
    10651065

    10661066
    ```bash
    1067-
    npm i -g node-core-utils
    1067+
    npm i -g @node-core/utils
    10681068
    ```
    10691069

    10701070
    Run the prepare LTS release command:
    @@ -1110,7 +1110,7 @@ current LTS codename in its release line changelog file.
    11101110

    11111111
    The `test/parallel/test-process-release.js` file might also need to be updated.
    11121112

    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
    11141114
    currently running these steps manually it's a good idea to refer to previous
    11151115
    LTS proposal PRs and make sure all required changes are covered.
    11161116

    ‎onboarding.md‎

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -10,7 +10,7 @@ onboarding session.
    1010
    possible to add them to the organization if they are not using two-factor
    1111
    authentication. If they cannot receive SMS messages from GitHub, try
    1212
    [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
    1414
    [set up the credentials][] for it.
    1515

    1616
    ## Fifteen minutes before the onboarding session
    @@ -230,7 +230,7 @@ needs to be pointed out separately during the onboarding.
    230230
    request.
    231231
    * Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:`
    232232
    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
    234234
    process. See the documentation of [`git-node`][].
    235235
    * [`core-validate-commit`][] automates the validation of commit messages.
    236236
    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.
    260260
    [Labels]: doc/contributing/collaborator-guide.md#labels
    261261
    [Landing pull requests]: doc/contributing/collaborator-guide.md#landing-pull-requests
    262262
    [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
    263264
    [`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests
    264265
    [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit
    265266
    [`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
    267267
    [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials
    268268
    [static-analysis]: doc/contributing/static-analysis.md
    269269
    [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/

    0 commit comments

    Comments
     (0)
    0