normal-github-client v0.0.15

Normal GitHub Client

This client is being used for repeated github tasks, like creating repositories with all its different settings.

Installation

Firstly you need node8 to run this tool. Then you can install the package:

$ npm i -g normal-github-client

Environment

You can set the following variables in your environment to ease the process of using the tool:

export GITHUB_CLIENT_DEFAULT_ORGANISATION=
export GITHUB_CLIENT_DEFAULT_REPOSITORY=
export GITHUB_CLIENT_DEFAULT_TEAM_ID_ARRAY=
export GITHUB_CLIENT_DEFAULT_DESCRIPTION=

export GITHUB_CLIENT_DEFAULT_TEST_ORGANISATION=
export GITHUB_CLIENT_DEFAULT_TEST_TEAM=
export GITHUB_CLIENT_DEFAULT_TEST_CANDIDATE=
export GITHUB_CLIENT_DEFAULT_TEST_REPO=

export GITHUB_CLIENT_GITHUB_TOKEN=
export GITHUB_CLIENT_PULLAPPROVE_TOKEN=

How to use

You can run the tool like this:

$ normal-github-client --task=createRepository --verbose

Or with npx :tada:

$ npx normal-github-client@latest --task=createRepository

This will take you through an interactive tool where you can set the different values.

Tasks

• createRepository: Creates a repository and runs the normalize task right after.
• normalizeRepository: Normalizes an existing repository.
• deleteRepository: Delete a repository (mind that you need special permissions on your token for this one).
• listOrganisationTeams: List the teams for an organisation.
• listOrganisationRepos: List the repos for an organisation.
• spawnTest: Spawn a developer test.
• updateLabels: Update the labels of an existing repository.
• unseatCandidates: Unseat outside collaborators that haven't been active for n weeks.

Contributing

You can add new tasks in the src/tasks folder and the questions that go with this task you can add in the src/questions folder.

Publishing a new version

Go into the folder and run:

$ npm run patch|minor|major
$ npm publish .