github - npm Package Compare versions
Comparing version 13.1.1 to 14.0.0
101
package.json
| { | ||
| "name": "github", | ||
| "version": "13.1.1", | ||
| "description": "GitHub REST API client for Node.js", | ||
| "author": "Mike de Boer <info@mikedeboer.nl>", | ||
| "contributors": [ | ||
| { | ||
| "name": "Mike de Boer", | ||
| "email": "info@mikedeboer.nl" | ||
| }, | ||
| { | ||
| "name": "Fabian Jakobs", | ||
| "email": "fabian@c9.io" | ||
| }, | ||
| { | ||
| "name": "Joe Gallo", | ||
| "email": "joe@brassafrax.com" | ||
| }, | ||
| { | ||
| "name": "Gregor Martynus", | ||
| "url": "https://github.com/gr2m" | ||
| } | ||
| ], | ||
| "repository": "https://github.com/octokit/node-github", | ||
| "engines": { | ||
| "node": ">=4" | ||
| }, | ||
| "dependencies": { | ||
| "debug": "^3.1.0", | ||
| "dotenv": "^4.0.0", | ||
| "https-proxy-agent": "^2.1.0", | ||
| "is-stream": "^1.1.0", | ||
| "lodash": "^4.17.4", | ||
| "proxy-from-env": "^1.0.0", | ||
| "url-template": "^2.0.8" | ||
| }, | ||
| "devDependencies": { | ||
| "@octokit/fixtures": "^5.4.0", | ||
| "apidoc": "^0.17.6", | ||
| "chai": "^4.1.2", | ||
| "coveralls": "^3.0.0", | ||
| "gh-pages-with-token": "^1.0.0", | ||
| "glob": "^7.1.2", | ||
| "mkdirp": "^0.5.1", | ||
| "mocha": "^4.0.1", | ||
| "mustache": "^2.2.1", | ||
| "nock": "^9.1.0", | ||
| "npm-run-all": "^4.1.1", | ||
| "nyc": "^11.2.1", | ||
| "proxyquire": "^1.8.0", | ||
| "semantic-release": "^11.0.0", | ||
| "simple-mock": "^0.8.0", | ||
| "standard": "^10.0.3", | ||
| "standard-markdown": "^4.0.2" | ||
| }, | ||
| "main": "lib", | ||
| "types": "lib/index.d.ts", | ||
| "scripts": { | ||
| "coverage": "nyc report --reporter=html && open coverage/index.html", | ||
| "coverage:upload": "nyc report --reporter=text-lcov | coveralls", | ||
| "pretest": "standard && standard-markdown", | ||
| "test": "nyc mocha 'test/**/*-test.js'", | ||
| "test:examples": "node test/examples.js", | ||
| "build": "npm-run-all build:*", | ||
| "prebuild:docs": "mkdirp doc/", | ||
| "build:docs": "node scripts/generate-api-docs", | ||
| "postbuild:docs": "apidoc -i doc/ -o apidoc/", | ||
| "build:flow": "node scripts/generate-flow-types", | ||
| "build:ts": "node scripts/generate-typescript-types", | ||
| "deploy-docs": "gh-pages-with-token -d apidoc", | ||
| "presemantic-release": "npm run -s build", | ||
| "semantic-release": "semantic-release", | ||
| "postpublish": "npm run -s deploy-docs" | ||
| }, | ||
| "license": "MIT", | ||
| "licenses": [ | ||
| { | ||
| "type": "The MIT License", | ||
| "url": "http://www.opensource.org/licenses/mit-license.php" | ||
| } | ||
| ], | ||
| "files": [ | ||
| "lib" | ||
| ], | ||
| "apidoc": { | ||
| "template": { | ||
| "withCompare": false | ||
| } | ||
| }, | ||
| "nyc": { | ||
| "ignore": [ | ||
| "examples", | ||
| "test" | ||
| ] | ||
| }, | ||
| "publishConfig": { | ||
| "tag": "next" | ||
| } | ||
| "version": "14.0.0", | ||
| "description": "DEPRECATED: renamed to @octokit/rest", | ||
| "repository": "https://github.com/octokit/rest.js", | ||
| "homepage": "https://git.io/vNB11", | ||
| "deprecated": "'github' has been renamed to '@octokit/rest' (https://git.io/vNB11)" | ||
| } |
212
README.md
@@ -1,211 +0,3 @@ | ||
| # node-github | ||
| # "github" has been renamed to "[@octokit/rest](https://www.npmjs.com/package/@octokit/rest)" | ||
| > GitHub REST API client for Node.js | ||
| [](https://travis-ci.org/octokit/node-github) | ||
| [](https://coveralls.io/github/octokit/node-github) | ||
| [](https://greenkeeper.io/) | ||
| [](https://www.npmjs.com/package/github) | ||
| ## Installation | ||
| Install via npm. | ||
| ```bash | ||
| npm install github | ||
| ``` | ||
| or install via git clone: | ||
| ```bash | ||
| git clone https://github.com/octokit/node-github | ||
| cd node-github | ||
| npm install | ||
| ``` | ||
| ## Documentation | ||
| Client API: [octokit.github.io/node-github](https://octokit.github.io/node-github/) | ||
| GitHub API: [developer.github.com/v3](https://developer.github.com/v3/) | ||
| ## Example | ||
| Get all followers for user "defunkt": | ||
| <!-- HEADS UP: when changing the options for the constructor, make sure to also | ||
| update the type definition templates in scripts/templates/* --> | ||
| ```js | ||
| var GitHubApi = require('github') | ||
| var github = new GitHubApi({ | ||
| // optional | ||
| timeout: 5000, | ||
| host: 'github.my-GHE-enabled-company.com', // should be api.github.com for GitHub | ||
| pathPrefix: '/api/v3', // for some GHEs; none for GitHub | ||
| protocol: 'https', | ||
| port: 9898, | ||
| proxy: '<proxyUrl>', | ||
| ca: 'whatever', | ||
| headers: { | ||
| 'accept': 'application/vnd.github.something-custom', | ||
| 'cookie': 'something custom', | ||
| 'user-agent': 'something custom' | ||
| }, | ||
| requestMedia: 'application/vnd.github.something-custom', | ||
| rejectUnauthorized: false, // default: true | ||
| family: 6 | ||
| }) | ||
| // TODO: optional authentication here depending on desired endpoints. See below in README. | ||
| github.users.getFollowingForUser({ | ||
| // optional | ||
| // headers: { | ||
| // "cookie": "blahblah" | ||
| // }, | ||
| username: 'defunkt' | ||
| }, function (err, res) { | ||
| if (err) throw err | ||
| console.log(JSON.stringify(res)) | ||
| }) | ||
| ``` | ||
| ## Pagination | ||
| There are a few pagination-related methods: | ||
| ``` | ||
| hasNextPage(link) | ||
| hasPreviousPage(link) | ||
| hasFirstPage(link) | ||
| hasLastPage(link) | ||
| getNextPage(link, headers, callback) | ||
| getPreviousPage(link, headers, callback) | ||
| getFirstPage(link, headers, callback) | ||
| getLastPage(link, headers, callback) | ||
| NOTE: link is the response object or the contents of the Link header | ||
| ``` | ||
| See [here](https://github.com/octokit/node-github/blob/master/examples/paginationCustomHeaders.js) and [here](https://github.com/octokit/node-github/blob/master/examples/getStarred.js) for examples. | ||
| ## Authentication | ||
| Most GitHub API calls don't require authentication. As a rule of thumb: If you can see the information by visiting the site without being logged in, you don't have to be authenticated to retrieve the same information through the API. Of course calls, which change data or read sensitive information have to be authenticated. | ||
| You need the GitHub user name and the API key for authentication. The API key can be found in the user's _Account Settings_. | ||
| ```javascript | ||
| // basic | ||
| github.authenticate({ | ||
| type: 'basic', | ||
| username: process.env.USERNAME, | ||
| password: process.env.PASSWORD | ||
| }) | ||
| // oauth | ||
| github.authenticate({ | ||
| type: 'oauth', | ||
| token: process.env.AUTH_TOKEN | ||
| }) | ||
| // oauth key/secret (to get a token) | ||
| github.authenticate({ | ||
| type: 'oauth', | ||
| key: process.env.CLIENT_ID, | ||
| secret: process.env.CLIENT_SECRET | ||
| }) | ||
| // user token | ||
| github.authenticate({ | ||
| type: 'token', | ||
| token: 'userToken' | ||
| }) | ||
| // integration (jwt) | ||
| github.authenticate({ | ||
| type: 'integration', | ||
| token: 'jwt' | ||
| }) | ||
| ``` | ||
| Note: `authenticate` is synchronous because it only stores the | ||
| credentials for the next request. | ||
| ### Creating a token for your application | ||
| [Create a new authorization](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization). | ||
| 1. Use github.authenticate() to authenticate with GitHub using your username / password. | ||
| 2. Create an application token programmatically with the scopes you need and, if you use two-factor authentication send the `X-GitHub-OTP` header with the one-time-password you get on your token device. | ||
| ```javascript | ||
| github.authorization.create({ | ||
| scopes: ['user', 'public_repo', 'repo', 'repo:status', 'gist'], | ||
| note: 'what this auth is for', | ||
| note_url: 'http://url-to-this-auth-app', | ||
| headers: { | ||
| 'X-GitHub-OTP': 'two-factor-code' | ||
| } | ||
| }, function (err, res) { | ||
| if (err) throw err | ||
| if (res.token) { | ||
| // save and use res.token as in the Oauth process above from now on | ||
| } | ||
| }) | ||
| ``` | ||
| ## DEBUG | ||
| Set `DEBUG=node-github*` for additional debug logs. | ||
| ## Tests | ||
| Run all tests | ||
| ```bash | ||
| $ npm test | ||
| ``` | ||
| Or run a specific test | ||
| ```bash | ||
| $ ./node_modules/.bin/mocha test/test/integration/get-repository-test.js | ||
| ``` | ||
| The examples are run as part of the tests. You can set an `EXAMPLES_GITHUB_TOKEN` environment | ||
| variable (or set it in a `.env` file) to avoid running against GitHub's rate limit. | ||
| ## Preview APIs | ||
| Accept headers for the preview APIs should be taken care of behind the scenes, but in the event a preview endpoint isn't working, see [here](https://github.com/octokit/node-github/blob/master/examples/getRawBlob.js) for an example on how to add the required custom accept header. | ||
| For updates on endpoints under preview, see https://developer.github.com/changes/. | ||
| | Preview API | Accept header val | | ||
| | ------------------- | ----------------------------------------------- | | ||
| | Blocking Users | application/vnd.github.giant-sentry-fist-preview+json | | ||
| | Codes of Conduct | application/vnd.github.scarlet-witch-preview+json | | ||
| | Commit Search | application/vnd.github.cloak-preview+json | | ||
| | Community | application/vnd.github.black-panther-preview+json | | ||
| | Deployment | application/vnd.github.ant-man-preview+json | | ||
| | Git signing | application/vnd.github.cryptographer-preview | | ||
| | Imports | application/vnd.github.barred-rock-preview | | ||
| | Integrations | application/vnd.github.machine-man-preview | | ||
| | License | application/vnd.github.drax-preview+json | | ||
| | Marketplace | application/vnd.github.valkyrie-preview+json | | ||
| | Migrations | application/vnd.github.wyandotte-preview+json | | ||
| | Nested Teams | application/vnd.github.hellcat-preview+json | | ||
| | Pages | application/vnd.github.mister-fantastic-preview | | ||
| | Pre-receive | application/vnd.github.eye-scream-preview | | ||
| | Projects | application/vnd.github.inertia-preview+json | | ||
| | Pull Request Squash | application/vnd.github.polaris-preview | | ||
| | Reactions | application/vnd.github.squirrel-girl-preview | | ||
| | Review Requests | application/vnd.github.thor-preview+json | | ||
| | Star Creation Timestamp | application/vnd.github.v3.star+json | | ||
| | Timeline | application/vnd.github.mockingbird-preview | | ||
| | Topics | application/vnd.github.mercy-preview+json | | ||
| ## LICENSE | ||
| [MIT](LICENSE) | ||
| See https://github.com/octokit/rest.js/releases/tag/v14.0.0 for upgrade instructions. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Trivial Package
Supply chain riskPackages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No License Found
License(Experimental) License information could not be found.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 3 instances in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Dependency count
- decreased by-100%
0
- Dev dependency count
- decreased by-100%
0
- Number of low quality alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-99.68%
1755
- Number of package files
- decreased by-44.44%
5
- Number of low license alerts
- increased byInfinity%
1
- Lines of code
- decreased by-99.99%
1
- Number of low maintenance alerts
- increased by50%
3
- Number of lines in readme file
- decreased by-98.11%
4
Dependency changes
- Removeddebug@^3.1.0
- Removeddotenv@^4.0.0
- Removedhttps-proxy-agent@^2.1.0
- Removedis-stream@^1.1.0
- Removedlodash@^4.17.4
- Removedproxy-from-env@^1.0.0
- Removedurl-template@^2.0.8
- Removedagent-base@4.3.0(transitive)
- Removeddebug@3.2.7(transitive)
- Removeddotenv@4.0.0(transitive)
- Removedes6-promise@4.2.8(transitive)
- Removedes6-promisify@5.0.0(transitive)
- Removedhttps-proxy-agent@2.2.4(transitive)
- Removedis-stream@1.1.0(transitive)
- Removedlodash@4.17.21(transitive)
- Removedms@2.1.3(transitive)
- Removedproxy-from-env@1.1.0(transitive)
- Removedurl-template@2.0.8(transitive)