Skip to content

transitive-bullshit/puppeteer-github

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

puppeteer-github

GitHub automation driven by headless chrome.

NPM Build Status JavaScript Style Guide

This module also has a CLI.

Install

npm install --save puppeteer-github

Usage

This example signs into a GitHub account.

const PuppeteerGitHub = require('puppeteer-github')

const github = new PuppeteerGitHub()

await github.signin({ username: 'xxx', password: 'xxx' })
await github.starRepo('facebook/react')

await github.close()

API

Table of Contents

PuppeteerGitHub

GitHub automation driven by headless chrome.

Type: function (opts)


isAuthenticated

Whether or not this instance is authenticated with GitHub.

Type: boolean


user

Authenticated user if authenticated with GitHub.

Type: Object


browser

Puppeteer Browser instance to use.

Type: function ()


signup

Automates the creation of a new GitHub account.

Type: function (user, opts): Promise

  • user object User details for new account
  • opts object Options (optional, default {})
    • opts.verifyEmail boolean? Whether or not to verify email
    • opts.emailPassword string? Email password for verification

signin

Signs into an existing GitHub account.

Note: either username or email is required.

Type: function (user, opts): Promise

  • user Object User details for new account
  • opts Object Options (optional, default {})

signout

Signs out of the currently authenticated GitHub account.

Type: function (): Promise


verifyEmail

Verifies the authenticated GitHub account's email via pupeteer-email.

Type: function (opts): Promise

  • opts Object Options
    • opts.emailPassword string Email password for verification
    • opts.email string? Email verification (defaults to user's GitHub email)

starPackage

Stars an npm package's github repository.

Type: function (pkgName): Promise

  • pkgName string NPM package name

Example:

const gh = new PuppeteerGitHub()
await gh.signin(...)
await gh.starPackage('react')
await gh.close()

unstarPackage

Unstars an npm package's github repository.

Type: function (pkgName): Promise

  • pkgName string NPM package name

starRepo

Stars a github repository.

Type: function (repo): Promise

  • repo string GitHub repository identifier

Example:

const gh = new PuppeteerGitHub()
await gh.signin(...)
await gh.starRepo('avajs/ava')
await gh.starRepo('https://github.com/facebook/react')
await gh.close()

unstarRepo

Unstars a github repository.

Type: function (repo): Promise

  • repo string GitHub repository identifier

close

Closes the underlying browser instance, effectively ending this session.

Type: function (): Promise


Related

License

MIT © Travis Fischer

Support my OSS work by following me on twitter twitter

About

GitHub automation driven by headless chrome.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published