This package has been deprecated

Author message:

This package is no longer maintained. If you would like to use the functionality offered by this package, please consider publishing a fork of this package under your own npm scope.

github-app-repositories

2.0.2 • Public • Published

github-app-repositories

Fetch the full name of all repositories accessible to a GitHub App.

Fetch the full name, such as org/repository of all repositories that are accessible to a GitHub App because the application was intalled on an entire organization, or because it was installed on the specific repository.

Table of Contents

Installation

To install github-app-repositories for use in your project please run the following command:

yarn add github-app-repositories

Usage

To fetch all repositories accessible to a GitHub App you will need to pass the application ID and private key to applicationID and applicationKey respectively:

const githubAppRepositories = require(`github-app-repositories`);
 
githubAppRepositories({applicationID, applicationKey})
  .then(repositories => repositories.forEach(({fullName, installationID}) => {
    console.log(fullName, installationID);
  }));

An array of objects is returned with each object containing the full name of the repository, including it's organization, such as org/repository, and the installation on which it belongs.

Node Support Policy

We only support Long-Term Support versions of Node.

We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.

It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.

As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.

We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.

JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.

Contributing

Please read our contributing guide on how you can help improve this project.

Readme

Keywords

Package Sidebar

Install

npm i github-app-repositories

Weekly Downloads

1

Version

2.0.2

License

Apache-2.0

Unpacked Size

12 kB

Total Files

4

Last publish

Collaborators

  • hutson