README
¶
go-githubstream
Fetch commits from a GitHub repository periodically. Uses go-github under the hood.
Installation
$ go get github.com/jsantell/go-githubstream
Documentation
Document can be found on GoDoc
Example
package main
import "fmt"
import "time"
import "github.com/jsantell/go-githubstream"
var TOKEN string = os.Getenv("GITHUB_ACCESS_TOKEN")
func main() {
ghs := githubstream.NewGithubStream(time.Hour, time.Hour * 10, "jsantell", "go-githubstream", "master", TOKEN)
// This fetches the github repo `jsantell/go-githubstream` once an hour,
// fetching commits from that point to 10 hours prior,
// and prints the commits
for commits := range ghs.Start() {
fmt.Println(commits)
}
}
License
MIT, Copyright (c) 2014 Jordan Santell
Documentation
¶
Index ¶
Constants ¶
View Source
const VERSION = "0.2.0"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GithubStream ¶
type GithubStream struct {
Stream chan []github.RepositoryCommit
Client *github.Client
Ticker *time.Ticker
Owner string
Repo string
Branch string
Token string
// How often the Github repository should be queried.
Frequency time.Duration
// From when should the commits be fetched; a `Since` of 8 hours
// indicates that on every query, get all commits from 8 hours ago
// up to the current time.
Since time.Duration
}
func NewGithubStream ¶
func (*GithubStream) Start ¶
func (ghs *GithubStream) Start() chan []github.RepositoryCommit
func (*GithubStream) Stop ¶
func (ghs *GithubStream) Stop()
Source Files
Click to show internal directories.
Click to hide internal directories.