env

README

env

全局公用环境变量

Documentation

Index

• Constants
• func AppVersion() string
• func BuildTime() string
• func DeployColor() string
• func DeployEnvironment() string
• func Env(name string) string
• func EnvInt(name string) (int, bool)
• func GetEnvKey(env string) string
• func GitCommit() string
• func GitTag() string
• func GoVersion() string
• func HostID() int
• func Hostname() string
• func IntEnvOr(key string, defaultValue int) int
• func IsDev() bool
• func IsProduction() bool
• func IsStaging() bool
• func IsTest() bool
• func StartTime() string
• func StringEnvOr(key string, defaultValue string) string
• func WorkDir() string

Constants

const (
	NextEnvPrefix        = "NEXT_"
	HostIDKey            = "HOST_ID"
	HostnameKey          = "HOST_NAME"
	WorkPathKey          = "WORK_PATH"
	DeployColorKey       = "DEPLOY_COLOR"
	DeployEnvironmentKey = "DEPLOY_ENV"
)

const (
	Dev        = "dev"        // 开发环境
	Test       = "testing"    // 环境环境
	Staging    = "staging"    // 预发环境
	Production = "production" // 线上环境
)

Functions

func AppVersion

func AppVersion() string

AppVersion get app version

func BuildTime

func BuildTime() string

BuildTime get buildTime

func DeployColor

func DeployColor() string

DeployColor is the identification of different experimental group in one caster cluster.

func DeployEnvironment

func DeployEnvironment() string

DeployEnvironment get deploy environment

func Env

func Env(name string) string

Env returns the value of the given environment variable.

func EnvInt

func EnvInt(name string) (int, bool)

EnvInt returns an int value of the given environment variable.

func GetEnvKey

func GetEnvKey(env string) string

GetEnvKey get env key: NEXT_{env}

func GitCommit

func GitCommit() string

GitCommit git commit

func GitTag

func GitTag() string

GitTag git tag

func GoVersion

func GoVersion() string

GoVersion get go version

func HostID

func HostID() int

HostID get host id

func Hostname

func Hostname() string

Hostname get hostname

func IntEnvOr

func IntEnvOr(key string, defaultValue int) int

IntEnvOr returns the int value of the environment variable with name key if it exists and the value is an int. Otherwise, defaultValue is returned.

func IsDev

func IsDev() bool

IsDev is dev environment

func IsProduction

func IsProduction() bool

IsProduction is production environment

func IsStaging

func IsStaging() bool

IsStaging is staging environment

func IsTest

func IsTest() bool

IsTest is test environment

func StartTime

func StartTime() string

StartTime get start time

func StringEnvOr

func StringEnvOr(key string, defaultValue string) string

StringEnvOr returns the string value of the environment variable with name key if it exists and the value is an string. Otherwise, defaultValue is returned.

func WorkDir

func WorkDir() string

WorkDir work path.