diff --git a/doc/access.md b/doc/access.md index 077f7ac77..df02a68f0 100644 --- a/doc/access.md +++ b/doc/access.md @@ -101,6 +101,27 @@ Those with `github-bot` access have access to the GitHub Bot's configuration, including GitHub and Jenkins secrets. The list of members is [here][GitHub Bot Admins]. +## NPM Management + +We have a number of modules under the Node.js Foundation including: + +* [citgm](https://github.com/nodejs/citgm) +* [llnode](https://github.com/nodejs/llnode) +* [node-gyp](https://github.com/nodejs/node-gyp) +* [node-inspect](https://github.com/nodejs/node-inspect) +* [node-report](https://github.com/nodejs/node-report) + +Modules are managed as follows: + +* The [`nodejs-foundation`][] npm user, which is managed by the Build + WG, is an administrator on all Foundation npm packages. It is the +means to add or remove other module collaborators, and shouldn't be used +to publish releases. +* Package mantainers are added as npm "collaborators" to the package, + and publish releases. + +The credentials required for the `nodejs-foundation` user are maintained in +encrypted form in the [secrets repo][]. [@nodejs/build]: https://github.com/orgs/nodejs/teams/build/members [@nodejs/collaborators]: https://github.com/orgs/nodejs/teams/collaborators/members @@ -136,3 +157,4 @@ including GitHub and Jenkins secrets. The list of members is [IRC]: /README.md#nodejs-build-working-group [the Readme]: /README.md [the onboarding doc]: /ONBOARDING.md +[`nodejs-foundation`]: https://www.npmjs.com/~nodejs-foundation diff --git a/doc/process/npm_management.md b/doc/process/npm_management.md deleted file mode 100644 index d813735c0..000000000 --- a/doc/process/npm_management.md +++ /dev/null @@ -1,41 +0,0 @@ -# NPM Management - -We have a number of modules under the Node.js Foundation including: - -* [citgm](https://github.com/nodejs/citgm) -* [llnode](https://github.com/nodejs/llnode) -* [node-gyp](https://github.com/nodejs/node-gyp) -* [node-inspect](https://github.com/nodejs/node-inspect) -* [node-report](https://github.com/nodejs/node-report) - -We need to make sure that we have continuity in terms of being able to publish -and update these modules. - -We have decided to manage these modules as follows: - -* Create a user called [`nodejs-foundation`][] who we always add as one of the - collaborators with admin rights and for which the password is maintained by - the build workgroup. -* We would then add individuals as collaborators who can also publish. - Generally, a module push will be done by the additional collaborators. - The `nodejs-foundation` user is intended to be used as a backup as opposed - to being part of the regular publishing flow. -* In the cases where collaborators other than `nodejs-foundation` - cease to be active, the build workgroup would provide continuity by using the - `node-foundation` user to add additional collaborators who would have the - ability to push the module. The `node-foundation` user could also be used to - remove collaborators if that was ever necessary. -* The purpose of the `nodejs-foundation` user is not to enable Build - Workgroup members to publish npm modules, that should be left to the - module collaborators. - -This approach is consistent with how npm modules have been managed by a number -of the companies who are foundation members and reports are that it has worked -well. - -The credentials required for the `nodejs-foundation` user are maintained in -encrypted form in the [secrets repo][]. - - -[`nodejs-foundation`]: https://www.npmjs.com/~nodejs-foundation -[secrets repo]: https://github.com/nodejs/secrets/tree/master/test/test_credentials.md