iframe-proxy | Sunbelt Computer Software

175 lines (144 loc) · 5.12 KB
// Copyright 2016 The go-github AUTHORS. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// These examples are inlined in godoc.
package github_test
	"github.com/google/go-github/v53/github"
func ExampleClient_Markdown() {
	client := github.NewClient(nil)
	input := "# heading #\n\nLink to issue #1"
	opt := &github.MarkdownOptions{Mode: "gfm", Context: "google/go-github"}
	ctx := context.Background()
	output, _, err := client.Markdown(ctx, input, opt)
	if err != nil {
		fmt.Println(err)
	fmt.Println(output)
func ExampleRepositoriesService_GetReadme() {
	client := github.NewClient(nil)
	ctx := context.Background()
	readme, _, err := client.Repositories.GetReadme(ctx, "google", "go-github", nil)
	if err != nil {
		fmt.Println(err)
	content, err := readme.GetContent()
	if err != nil {
		fmt.Println(err)
	fmt.Printf("google/go-github README:\n%v\n", content)
func ExampleRepositoriesService_List() {
	client := github.NewClient(nil)
	user := "willnorris"
	opt := &github.RepositoryListOptions{Type: "owner", Sort: "updated", Direction: "desc"}
	ctx := context.Background()
	repos, _, err := client.Repositories.List(ctx, user, opt)
	if err != nil {
		fmt.Println(err)
	fmt.Printf("Recently updated repositories by %q: %v", user, github.Stringify(repos))
func ExampleRepositoriesService_CreateFile() {
	// In this example we're creating a new file in a repository using the
	// Contents API. Only 1 file per commit can be managed through that API.
	// Note that authentication is needed here as you are performing a modification
	// so you will need to modify the example to provide an oauth client to
	// github.NewClient() instead of nil. See the following documentation for more
	// information on how to authenticate with the client:
	// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
	client := github.NewClient(nil)
	ctx := context.Background()
	fileContent := []byte("This is the content of my file\nand the 2nd line of it")
	// Note: the file needs to be absent from the repository as you are not
	// specifying a SHA reference here.
	opts := &github.RepositoryContentFileOptions{
		Message:   github.String("This is my commit message"),
		Content:   fileContent,
		Branch:    github.String("master"),
		Committer: &github.CommitAuthor{Name: github.String("FirstName LastName"), Email: github.String("user@example.com")},
	_, _, err := client.Repositories.CreateFile(ctx, "myOrganization", "myRepository", "myNewFile.md", opts)
	if err != nil {
		fmt.Println(err)
func ExampleUsersService_ListAll() {
	client := github.NewClient(nil)
	opts := &github.UserListOptions{}
		ctx := context.Background()
		users, _, err := client.Users.ListAll(ctx, opts)
		if err != nil {
			log.Fatalf("error listing users: %v", err)
		if len(users) == 0 {
		opts.Since = *users[len(users)-1].ID
		// Process users...
func ExamplePullRequestsService_Create() {
	// In this example we're creating a PR and displaying the HTML url at the end.
	// Note that authentication is needed here as you are performing a modification
	// so you will need to modify the example to provide an oauth client to
	// github.NewClient() instead of nil. See the following documentation for more
	// information on how to authenticate with the client:
	// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
	client := github.NewClient(nil)
	newPR := &github.NewPullRequest{
		Title:               github.String("My awesome pull request"),
		Head:                github.String("branch_to_merge"),
		Base:                github.String("master"),
		Body:                github.String("This is the description of the PR created with the package `github.com/google/go-github/github`"),
		MaintainerCanModify: github.Bool(true),
	ctx := context.Background()
	pr, _, err := client.PullRequests.Create(ctx, "myOrganization", "myRepository", newPR)
	if err != nil {
		fmt.Println(err)
	fmt.Printf("PR created: %s\n", pr.GetHTMLURL())
func ExampleTeamsService_ListTeams() {
	// This example shows how to get a team ID corresponding to a given team name.
	// Note that authentication is needed here as you are performing a lookup on
	// an organization's administrative configuration, so you will need to modify
	// the example to provide an oauth client to github.NewClient() instead of nil.
	// See the following documentation for more information on how to authenticate
	// with the client:
	// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
	client := github.NewClient(nil)
	teamName := "Developers team"
	ctx := context.Background()
	opts := &github.ListOptions{}
		teams, resp, err := client.Teams.ListTeams(ctx, "myOrganization", opts)
		if err != nil {
			fmt.Println(err)
		for _, t := range teams {
			if t.GetName() == teamName {
				fmt.Printf("Team %q has ID %d\n", teamName, t.GetID())
		if resp.NextPage == 0 {
		opts.Page = resp.NextPage
	fmt.Printf("Team %q was not found\n", teamName)
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

examples_test.go

Latest commit

History

examples_test.go

File metadata and controls
