Workflow context

actions.go

@@ -22,6 +22,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/sethvargo/go-envconfig"
 	"io"
 	"io/ioutil"
 	"net/http"
@@ -415,3 +416,44 @@ func (c *Action) Getenv(key string) string {
 // GetenvFunc is an abstraction to make tests feasible for commands that
 // interact with environment variables.
 type GetenvFunc func(key string) string
+
+// Context of current workflow
+type Context struct {
+	Event            map[string]interface{}
+	EventPayloadPath string `env:"GITHUB_EVENT_PATH,required"`
+	EventName        string `env:"GITHUB_EVENT_NAME"`
+	SHA              string `env:"GITHUB_SHA"`
+	Ref              string `env:"GITHUB_REF"`
+	Workflow         string `env:"GITHUB_WORKFLOW"`
+	Action           string `env:"GITHUB_ACTION"`
+	Actor            string `env:"GITHUB_ACTOR"`
+	Job              string `env:"GITHUB_JOB"`
+	RunNumber        int    `env:"GITHUB_RUN_NUMBER"`
+	RunID            int    `env:"GITHUB_RUN_ID"`
+	APIURL           string `env:"GITHUB_API_URL,default=https://api.github.com"`
+	ServerURL        string `env:"GITHUB_SERVER_URL,default=https://github.com"`
+	GraphqlURL       string `env:"GITHUB_GRAPHQL_URL,default=https://api.github.com/graphql"`
+}
+
+// Context returns the context of current action with the payload object that triggered the workflow
+func (c *Action) Context(ctx context.Context) (*Context, error) {
+	var (
+		rawEvent  map[string]interface{}
+		githubCtx Context
+	)
+
+	if err := envconfig.Process(ctx, &githubCtx); err != nil {
+		return nil, fmt.Errorf("could not process context variables: %w", err)
+	}
+
+	eventData, err := ioutil.ReadFile(githubCtx.EventPayloadPath)
+	if err != nil {
+		return nil, fmt.Errorf("could not read event file: %w", err)
+	}
+
+	if err = json.Unmarshal(eventData, &rawEvent); err != nil {
+		return nil, fmt.Errorf("could not unmarshall event payload: %w", err)
+	}
+
+	return &githubCtx, nil
+}

go.mod

@@ -15,3 +15,5 @@
 module github.com/sethvargo/go-githubactions
 
 go 1.13
+
+require github.com/sethvargo/go-envconfig v0.5.0 // indirect

go.sum

@@ -0,0 +1,4 @@
+github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/sethvargo/go-envconfig v0.5.0 h1:puRfYHj1HUe03MSPVBW8zc2BtRyn/KySgZcICXOzpVg=
+github.com/sethvargo/go-envconfig v0.5.0/go.mod h1:00S1FAhRUuTNJazWBWcJGvEHOM+NO6DhoRMAOX7FY5o=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=