gha

Documentation

Overview

Package gha is a convenience object to use Workflow commands for Github Actions. https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions

Index

• type Github
  • func New(writer io.Writer) Github
  • func NewFromCli(cCtx *cli.Context) Github
  • func (g Github) SetOutput(name string, value interface{})

Types

type Github

type Github struct {
	// contains filtered or unexported fields
}

Github is an object that output workflow commands.

func New

func New(writer io.Writer) Github

New creates a Github object that will print commands to the specified writer.

func NewFromCli

func NewFromCli(cCtx *cli.Context) Github

NewFromCli takes a cli.Context and looks for common.GHAFlag on it. If it is set, it returns a Github object that writes to the app's Writer. If it is not, it returns an empty Github object that does not write anything.

func (Github) SetOutput

func (g Github) SetOutput(name string, value interface{})

SetOutput outputs the `set-output` command. https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter