https://github.com/lirantal/githubs-api

Manage GitHub repositories in bulk
https://github.com/lirantal/githubs-api

github github-api nodejs

Last synced: 21 days ago
JSON representation

Manage GitHub repositories in bulk

• Host: GitHub
• URL: https://github.com/lirantal/githubs-api
• Owner: lirantal
• License: apache-2.0
• Created: 2019-09-22T04:27:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-19T12:56:17.000Z (about 5 years ago)
• Last Synced: 2024-10-11T11:27:52.310Z (about 1 month ago)
• Topics: github, github-api, nodejs
• Language: JavaScript
• Size: 129 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  githubs-api





  Manage GitHub repositories in bulk





  

  

  

  

  

  

  



# About

Manage GitHub repositories in bulk

# Install

```bash

npm install --save githubs-api

```

# Usage

```js

const {GitHubRepos} = require('githubs-api')

// instantiate using a github token

const githubRepos = new GitHubRepos({

  githubtoken: 'abc'

})

// update repos in bulk based on settings

// specified in requestOptions

await githubRepos.update(requestOptions)

```

# Example

```js

const {GitHubRepos} = require('githubs-api')

// provide a personal developer access token

// obtained from the GitHub Developer Settings

// page at: https://github.com/settings/tokens

const githubRepos = new GitHubRepos({

  githubtoken: 'abc'

})

// this will update all github repositories owned by

// your user (as provided in the token) and set all

// of them to remove the issues tab from the project

// page

const requestOptions = {

  repoFilter: {

    type: 'owner'

  },

  features: {

    issues: 'off'

  }

}

const result = await githubRepos.update(requestOptions)

```

# API

Current API support:

| Class       | Methods                        |

| ----------- | ------------------------------ |

| GitHubRepos | update(repoFilter, features)   |

|             | getAll(repoFilter, nameFilter) |

# Contributing

Please consult [CONTIRBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.

# Author

**githubs-api** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.