env

Documentation

Overview

Package env implements environment related functionality.

Index

• func First(keys ...string) string
• func FirstOrDefault(def string, keys ...string) string
• func GitActionEventName() string
• func GitActionName() string
• func GitCommitSHA() string
• func GitRepoAndOwner() string
• func IS_GH_ACTION() bool
• func IsCI() bool
• func IsSet(keys ...string) bool
• func IsTruthy(keys ...string) bool

Functions

func First

func First(keys ...string) string

First is shorthand for FirstOrDefault("", keys...).

func FirstOrDefault

func FirstOrDefault(def string, keys ...string) string

FirstOrDefault retrieves the value of the first present environment variable named by the keys. In case no variable is present, FirstOrDefault returns def.

func GitActionEventName

func GitActionEventName() string

func GitActionName

func GitActionName() string

func GitCommitSHA

func GitCommitSHA() string

func GitRepoAndOwner

func GitRepoAndOwner() string

func IS_GH_ACTION

func IS_GH_ACTION() bool

func IsCI

func IsCI() bool

IsCI reports whether the environment is a CI one.

Based on https://github.com/watson/ci-info/blob/c4f1553f254c78babef5c200c48569ede313b718/index.js

func IsSet

func IsSet(keys ...string) bool

IsSet reports whether any of the environment variables named by the keys is set.

func IsTruthy

func IsTruthy(keys ...string) bool

IsTruthy reports whether any of the values of the environment variables named by the keys evaluates to true.