Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

node-core-utils

1.25.0 • Public • Published

Node.js Core Utilities

npm Build Status codecov Known Vulnerabilities

CLI tools for Node.js Core collaborators.

Tools

  • git-node: Custom Git commands for working with Node.js core, e.g. landing Pull Requests.
  • ncu-config: Configure variables for node-core-utils to use.
  • ncu-team: Listing members of a team, synchronizing special blocks in files with the list of members.
  • get-metadata: Retrieving metadata for a Pull Request. DEPRECATED: use git node metadata instead.
  • ncu-ci: Parse the results of a Jenkins CI run and display a summary for all the failures.

Usage

Install

npm install -g node-core-utils

If you would prefer to build from the source, install and link:

git clone git@github.com:nodejs/node-core-utils.git
cd node-core-utils
npm install
npm link

Setting up credentials

Most of the tools need your GitHub credentials to work. You can either

  1. Run any of the tools and you will be asked in a prompt to provide your username and password in order to create a personal access token.
  2. Or, create a personal access token yourself on GitHub, then set them up using an editor.

If you prefer option 2, follow these instructions to create the token.

When creating the token, the following boxes need to be checked:

  • user:email: Used by git-node and get-metadata to read the email of the PR author in order to check if it matches the email of the commit author.
  • read:org: Used by ncu-team to read the list of team members.

You can also edit the permission of existing tokens later.

After the token is generated, create an rc file with the following content: (~/.ncurc or $XDG_CONFIG_HOME/ncurc):

{
  "username": "your_github_username",
  "token": "token_that_you_created"
}

Note: you could use ncu-config to configure these variables, but it's not recommended to leave your tokens in your command line history.

Make sure your credentials won't be committed

Put the following entries into ~/.gitignore_global

# node-core-utils configuration file
.ncurc
# node-core-utils working directory
.ncu

Mind that.ncu/land could contain your access token since it contains the serialized configurations.

If you ever accidentally commit your access token on GitHub, you can simply revoke that token and use a new one.

Troubleshooting

If you encounter an error that you cannot fix by yourself, please

  1. Make sure you update NCU to the latest version
  2. Try again with the NCU_VERBOSITY=debug environment variable set and open an issue at https://github.com/nodejs/node-core-utils/issues with detailed logs.

Contributing

See CONTRIBUTING.md.

License

MIT. See LICENSE.

Keywords

none

Install

npm i node-core-utils

DownloadsWeekly Downloads

2,815

Version

1.25.0

License

MIT

Unpacked Size

261 kB

Total Files

89

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar