|
| 1 | +# ncu-team |
| 2 | + |
| 3 | +Listing members of a specific team, synchronize special blocks in files with |
| 4 | +the list of members. |
| 5 | + |
| 6 | +## Usage |
| 7 | + |
| 8 | +### List the members in a team |
| 9 | + |
| 10 | +The members will be sorted alphabetically by their login. |
| 11 | + |
| 12 | +``` |
| 13 | +$ ncu-team list automation-collaborators |
| 14 | +
|
| 15 | +- [@evanlucas](https://github.com/evanlucas) - Evan Lucas |
| 16 | +- [@joyeecheung](https://github.com/joyeecheung) - Joyee Cheung |
| 17 | +- [@MylesBorins](https://github.com/MylesBorins) - Myles Borins |
| 18 | +- [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot |
| 19 | +- [@rvagg](https://github.com/rvagg) - Rod Vagg |
| 20 | +- [@targos](https://github.com/targos) - Michaël Zasso |
| 21 | +``` |
| 22 | + |
| 23 | +### Synchronize files with special blocks |
| 24 | + |
| 25 | +`ncu-team sync` updates the special block `<!-- ncu-team-sync.team($org/$team) -->` |
| 26 | +with a list of members under the specified team. |
| 27 | + |
| 28 | +For example, if there is a file named `README.md` with text like this: |
| 29 | + |
| 30 | +```markdown |
| 31 | +## Collaborators in the automation team |
| 32 | + |
| 33 | +<!-- ncu-team-sync.team(nodejs/automation-collaborators) --> |
| 34 | + |
| 35 | +<!-- ncu-team-sync end --> |
| 36 | + |
| 37 | +## Bots in the Node.js organization |
| 38 | + |
| 39 | +<!-- ncu-team-sync.team(nodejs/bots) --> |
| 40 | + |
| 41 | +<!-- ncu-team-sync end --> |
| 42 | +``` |
| 43 | + |
| 44 | +Running this command: |
| 45 | + |
| 46 | +``` |
| 47 | +$ ncu-team sync README.md |
| 48 | +``` |
| 49 | + |
| 50 | +will update the file with text like this: |
| 51 | + |
| 52 | +```markdown |
| 53 | +## Collaborators in the automation team |
| 54 | + |
| 55 | +<!-- ncu-team-sync.team(nodejs/automation-collaborators) --> |
| 56 | + |
| 57 | +- [@evanlucas](https://github.com/evanlucas) - Evan Lucas |
| 58 | +- [@joyeecheung](https://github.com/joyeecheung) - Joyee Cheung |
| 59 | +- [@MylesBorins](https://github.com/MylesBorins) - Myles Borins |
| 60 | +- [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot |
| 61 | +- [@rvagg](https://github.com/rvagg) - Rod Vagg |
| 62 | +- [@targos](https://github.com/targos) - Michaël Zasso |
| 63 | + |
| 64 | +<!-- ncu-team-sync end --> |
| 65 | + |
| 66 | +## Bots in the Node.js organization |
| 67 | + |
| 68 | +<!-- ncu-team-sync.team(nodejs/bots) --> |
| 69 | + |
| 70 | +- [@nodejs-github-bot](https://github.com/nodejs-github-bot) - Node.js GitHub Bot |
| 71 | + |
| 72 | +<!-- ncu-team-sync end --> |
| 73 | +``` |
0 commit comments