richardlitt / gh-description Goto Github PK

View Code? Open in Web Editor NEW

7.0 3.0 4.0 70 KB

Set and get a GitHub repository description

License: MIT License

JavaScript 100.00%

github gh cli description js javascript

gh-description's Introduction

gh-description

Set and get a GitHub repository description

Install

npm install --save gh-description

npm install --global gh-description

Usage

const ghDescription = require('gh-description');

ghDescription('RichardLitt/gh-description');
//=> 'Set and get a GitHub repository description'
ghDescription('RichardLitt/gh-description', 'unicorns & rainbows');
//=> 'unicorns & rainbows'

API

ghDescription(repoName, description, [options], token)

repoName

Type: string

The name for the repository to test.

description

Type: string

The new description to set. To set, you must also supply the repoName first.

options

enterprise

Type: bool or string

Specify a different endpoint for the GitHub URL. Useful for GitHub Enterprise. Setting this flag as a boolean will automatically pull from the environmental variable GITHUB_ENDPOINT.

If using enterprise, the token must be explicitly set and cannot be passed through from the environment. This is to ensure that bad credentials from the public GitHub don't mess up the works.

Alias: e

token

Your GitHub access token, if not set as an env variable or supplied in the CLI.

CLI

The gh-description command uses ghauth to generate and locally store a GitHub API personal token.

You can skip this step by manually generating a token and setting it as an environment variable named GH_DESCRIPTION_TOKEN.

$ gh-description --help

  Usage
    $ gh-description [input]

  Options
    -e, --enterprise  Specify a different GitHub endpoint

  Examples
    $ gh-description
    Set and get a GitHub repository description
    $ gh-description RichardLitt/gh-description
    Set and get a GitHub repository description
    $ gh-description RichardLitt/gh-description 'ponies and unicorns'
    New description: ponies and unicorns
    $ gh-description RichardLitt/gh-description -e
    New enterprise description: Engage
    $ gh-description RichardLitt/gh-description -e https://scottymcscottface.co.uk
    New enterprise description: Beam Me Up

Contribute

PRs and issues gladly accepted!

License

MIT © Richard Littauer

gh-description's People

Contributors

Stargazers

Watchers

Forkers

laugen jonbonazza ayaz345

gh-description's Issues

GH API "Not Found" error

$ gh-description RichardLitt/gh-description 'ponies and unicorns'

{ Error: {"message":"Not Found","documentation_url":"https://developer.github.com/v3"}
    at /usr/local/lib/node_modules/gh-description/node_modules/octokat/dist/node/request.js:231:19
    at exports.XMLHttpRequest.xhr.onreadystatechange (/usr/local/lib/node_modules/gh-description/node_modules/octokat/dist/node/request.js:45:18)
    at exports.XMLHttpRequest.dispatchEvent (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:591:25)
    at setState (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:610:14)
    at IncomingMessage.<anonymous> (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:447:13)
    at emitNone (events.js:91:20)
    at IncomingMessage.emit (events.js:185:7)
    at endReadableNT (_stream_readable.js:974:12)
    at _combinedTickCallback (internal/process/next_tick.js:74:11)
    at process._tickCallback (internal/process/next_tick.js:98:9)
  status: 404,
  json: 
   { message: 'Not Found',
     documentation_url: 'https://developer.github.com/v3' } }
{ Error: {"message":"Not Found","documentation_url":"https://developer.github.com/v3"}
    at /usr/local/lib/node_modules/gh-description/node_modules/octokat/dist/node/request.js:231:19
    at exports.XMLHttpRequest.xhr.onreadystatechange (/usr/local/lib/node_modules/gh-description/node_modules/octokat/dist/node/request.js:45:18)
    at exports.XMLHttpRequest.dispatchEvent (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:591:25)
    at setState (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:610:14)
    at IncomingMessage.<anonymous> (/usr/local/lib/node_modules/gh-description/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:447:13)
    at emitNone (events.js:91:20)
    at IncomingMessage.emit (events.js:185:7)
    at endReadableNT (_stream_readable.js:974:12)
    at _combinedTickCallback (internal/process/next_tick.js:74:11)
    at process._tickCallback (internal/process/next_tick.js:98:9)
  status: 404,
  json: 
   { message: 'Not Found',
     documentation_url: 'https://developer.github.com/v3' } }

gh-description can get the description well but it fails once I try to set it (after asking for user/pass the first time)

Enable get without credentials

You shouldn't need to set these to use the module.

$ gh-description without arguments throws error

What request is this sending? What is does the command gh-description without any arguments do?

This happens in a public git repo folder.

Breaks for https remote urls in gitconfig

Try with: https://github.com/ipfs/archives

Fails on GitHub Enterprise

Issue with Oktocat. PRed in philschatz/octokat.js#201.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.