githubcli

Documentation

Overview

Package githubcli provides a command line interface to the GitHub CLI.

Index

• func GetContainer(ctx context.Context, runtime *daggers.Runtime, opts ...daggers.Option[config]) (*dagger.Container, error)
• func Run(ctx context.Context, runtime *daggers.Runtime, opts ...daggers.Option[config]) (string, error)
• func WithArgs(args ...string) daggers.Option[config]
• func WithContainerCustomizers(customizers ...containers.ContainerCustomizerFn) daggers.Option[config]
• func WithEnv(envMap map[string]string) daggers.Option[config]
• func WithExtensions(extensions ...string) daggers.Option[config]
• func WithGithubCliVersion(version string) daggers.Option[config]
• func WithGoImageRepo(repo string) daggers.Option[config]
• func WithGoImageTag(tag string) daggers.Option[config]
• func WithMountWorkDir(mount bool) daggers.Option[config]

Functions

func GetContainer

func GetContainer(
	ctx context.Context, runtime *daggers.Runtime, opts ...daggers.Option[config],
) (*dagger.Container, error)

GetContainer returns a dagger container instance with github cli as entrypoint.

func Run

func Run(ctx context.Context, runtime *daggers.Runtime, opts ...daggers.Option[config]) (string, error)

Run runs the ginkgo run command with given options.

func WithArgs

func WithArgs(args ...string) daggers.Option[config]

WithArgs sets the arguments to pass to github cli.

func WithContainerCustomizers

func WithContainerCustomizers(customizers ...containers.ContainerCustomizerFn) daggers.Option[config]

WithContainerCustomizers adds the container customizers to use for the container.

func WithEnv

func WithEnv(envMap map[string]string) daggers.Option[config]

WithEnv sets the environment variables to pass to go.

func WithExtensions

func WithExtensions(extensions ...string) daggers.Option[config]

WithExtensions sets the extensions to install for github cli.

func WithGithubCliVersion

func WithGithubCliVersion(version string) daggers.Option[config]

WithGithubCliVersion sets the github cli version to use for the container.

func WithGoImageRepo

func WithGoImageRepo(repo string) daggers.Option[config]

WithGoImageRepo sets whether to enable go module caching. Optional, defaults to docker.io/golang.

func WithGoImageTag

func WithGoImageTag(tag string) daggers.Option[config]

WithGoImageTag sets the go image tag to use for the container. Optional, defaults to 1.19.

func WithMountWorkDir

func WithMountWorkDir(mount bool) daggers.Option[config]

WithMountWorkDir sets whether to mount runtime workdir to the container. Optional, defaults to true.