githubrun

README

go-githubrun

go-githubrun is a Go library for parsing the event payload and default environment variables available to the Github workflow run instance.

Usage

import (
    "github.com/covertbyte/go-githubrun"
    "github.com/google/go-github/v32/github"
    "github.com/sethvargo/go-githubactions"
)

func main() {
    run, err := githubrun.ParseRun()
    if err != nil {
        githubactions.Fatalf("%w", err)
    }

    ctx := context.Background()
	ts := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: run.Env.GithubToken},
	)
	tc := oauth2.NewClient(ctx, ts)
	client := github.NewClient(tc)

    pullRequest := run.Payload.(*github.PullRequestEvent).GetPullRequest()

    githubactions.DebugF("%s", pullRequest.GetBody())

    githubactions.DebugF("%s", run.Env.GithubEventName)
}

For API documentation see the Go docs.

Documentation

Index

• type Env
• type Run
  • func ParseRun() (Run, error)

Types

type Env

type Env struct {
	CI               bool
	Home             string
	GithubWorkflow   string
	GithubRunID      int64
	GithubRunNumber  int64
	GithubAction     string
	GithubActions    bool
	GithubActor      string
	GithubRepository string
	GithubEventName  string
	GithubEventPath  string
	GithubWorkspace  string
	GithubSHA        string
	GithubRef        string
	GithubHeadRef    string
	GithubBaseRef    string
	GithubToken      string
}

Env contains the default environment variables.

https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token

type Run

type Run struct {
	Env        Env
	Payload    interface{}
	Owner      string
	Repository string
}

Run represents a Github run.

https://help.github.com/en/actions/reference/events-that-trigger-workflows

func ParseRun

func ParseRun() (Run, error)

ParseRun parses the event payload and default environment variables. A struct containing the env variables, and payload of the corresponding struct type will be returned.