aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/cli/internal/ci/ci.go
blob: a22ad78d2d5347e0ca9c4f031e66335bd0df8fdc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Package ci is a simple utility to check if a program is being executed in common CI/CD/PaaS vendors.
// This is a partial port of https://github.com/watson/ci-info
package ci

import "os"

var isCI = os.Getenv("BUILD_ID") != "" || os.Getenv("BUILD_NUMBER") != "" || os.Getenv("CI") != "" || os.Getenv("CI_APP_ID") != "" || os.Getenv("CI_BUILD_ID") != "" || os.Getenv("CI_BUILD_NUMBER") != "" || os.Getenv("CI_NAME") != "" || os.Getenv("CONTINUOUS_INTEGRATION") != "" || os.Getenv("RUN_ID") != "" || os.Getenv("TEAMCITY_VERSION") != "" || false

// IsCi returns true if the program is executing in a CI/CD environment
func IsCi() bool {
	return isCI
}

// Name returns the name of the CI vendor
func Name() string {
	return Info().Name
}

// Constant returns the name of the CI vendor as a constant
func Constant() string {
	return Info().Constant
}

// Info returns information about a CI vendor
func Info() Vendor {
	// check both the env var key and value
	for _, env := range Vendors {
		if env.EvalEnv != nil {
			for name, value := range env.EvalEnv {
				if os.Getenv(name) == value {
					return env
				}
			}
		} else {
			// check for any of the listed env var keys, with any value
			if env.Env.Any != nil && len(env.Env.Any) > 0 {
				for _, envVar := range env.Env.Any {
					if os.Getenv(envVar) != "" {
						return env
					}
				}
				// check for all of the listed env var keys, with any value
			} else if env.Env.All != nil && len(env.Env.All) > 0 {
				all := true
				for _, envVar := range env.Env.All {
					if os.Getenv(envVar) == "" {
						all = false
						break
					}
				}
				if all {
					return env
				}
			}
		}
	}
	return Vendor{}
}