ciinfo

README

CI Info

Acknowledgement

This repository is based on work done in watson/ci-info and the contributors.

I will do my best to keep this library up to date and in sync with changes in watson/ci-info.

---

Get details about the current Continuous Integration environment.

Installation

go get github.com/gkampitakis/ciinfo

Usage

import (
  "fmt"

  "github.com/gkampitakis/ciinfo"
)

if ciinfo.IsCI {
  fmt.Printf("The name of the CI server is: %s", ciinfo.Name)
} else {
  fmt.Printf("This program is not running on a CI server")
}

CLI Support

ciinfo can also be used as a CLI. You can install it with

go install github.com/gkampitakis/ciinfo/ciinfo@latest

Then ciinfo command will be successful ( code 0 ) if running on CI else error ( code -1 ).

#  will output isCI if running onCI
ciinfo && echo 'isCI'

ciinfo also has

Usage of ciinfo:
  -output string
    	you can output info [json, pretty].
  -pr
    	check if shell is running on CI for a Pull Request.

Supported CI tools

Officially supported CI servers:

Name	Constant	isPR
Agola CI	ci.AGOLA	✅
AWS CodeBuild	ciinfo.CODEBUILD	🚫
AppVeyor	ciinfo.APPVEYOR	✅
Azure Pipelines	ciinfo.AZURE_PIPELINES	✅
Appcircle	ciinfo.APPCIRCLE	🚫
Bamboo by Atlassian	ciinfo.BAMBOO	🚫
Bitbucket Pipelines	ciinfo.BITBUCKET	✅
Bitrise	ciinfo.BITRISE	✅
Buddy	ciinfo.BUDDY	✅
Buildkite	ciinfo.BUILDKITE	✅
CircleCI	ciinfo.CIRCLE	✅
Cirrus CI	ciinfo.CIRRUS	✅
Codefresh	ciinfo.CODEFRESH	✅
Codeship	ciinfo.CODESHIP	🚫
Drone	ciinfo.DRONE	✅
dsari	ciinfo.DSARI	🚫
Earthly CI	ci.EARTHLY	🚫
Expo Application Services	ciinfo.EAS	🚫
Gerrit CI	ciinfo.GERRIT	🚫
GitHub Actions	ciinfo.GITHUB_ACTIONS	✅
GitLab CI	ciinfo.GITLAB	✅
Gitea Actions	ci.GITEA_ACTIONS	🚫
GoCD	ciinfo.GOCD	🚫
Google Cloud Build	ciinfo.GOOGLE_CLOUD_BUILD	🚫
Harness CI	ciinfo.HARNESS	🚫
Heroku	ciinfo.HEROKU	🚫
Hudson	ciinfo.HUDSON	🚫
Jenkins CI	ciinfo.JENKINS	✅
LayerCI	ciinfo.LAYERCI	✅
Magnum CI	ciinfo.MAGNUM	🚫
Netlify CI	ciinfo.NETLIFY	✅
Nevercode	ciinfo.NEVERCODE	✅
Prow	ci.PROW	🚫
ReleaseHub	ciinfo.RELEASEHUB	✅
Render	ciinfo.RENDER	✅
Sail CI	ciinfo.SAIL	✅
Screwdriver	ciinfo.SCREWDRIVER	✅
Semaphore	ciinfo.SEMAPHORE	✅
Sourcehut	ciinfo.SOURCEHUT	🚫
Strider CD	ciinfo.STRIDER	🚫
TaskCluster	ciinfo.TASKCLUSTER	🚫
TeamCity by JetBrains	ciinfo.TEAMCITY	🚫
Travis CI	ciinfo.TRAVIS	✅
Vela	ci.VELA	✅
Vercel	ciinfo.VERCEL	✅
Visual Studio App Center	ciinfo.APPCENTER	🚫
Woodpecker	ciinfo.WOODPECKER	✅

API

ciinfo.Name

Returns a string containing name of the CI server the code is running on. If CI server is not detected, it returns empty string "".

Don't depend on the value of this string not to change for a specific vendor. If you find your self writing ciinfo.Name === "Travis CI", you most likely want to use ciinfo.IsVendor("TRAVIS") instead.

ciinfo.IsCI

Returns a boolean. Will be true if the code is running on a CI server, otherwise false.

Some CI servers not listed here might still trigger the ciinfo.isCI boolean to be set to true if they use certain vendor neutral environment variables. In those cases ciinfo.Name will be "" and no vendor specific boolean will be set to true.

ciinfo.IsPR

Returns a boolean if PR detection is supported for the current CI server. Will be true if a PR is being tested, otherwise false. If PR detection is not supported for the current CI server, the value will be false.

ciinfo.<VENDOR-CONSTANT>

A vendor specific boolean constant is exposed for each support CI vendor. A constant will be true if the code is determined to run on the given CI server, otherwise false.

Examples of vendor constants are ciinfo.TRAVIS or ciinfo.APPVEYOR. For a complete list, see the support table above.

Documentation

Index

• Variables
• func IsVendor(vendor string) bool

Variables

var (
	Name string
	IsPr bool
	IsCI bool
)

var AGOLA = vendorsIsCI["AGOLA"]

CI is running on Agola CI

var APPCENTER = vendorsIsCI["APPCENTER"]

CI is running on Visual Studio App Center

var APPCIRCLE = vendorsIsCI["APPCIRCLE"]

CI is running on Appcircle

var APPVEYOR = vendorsIsCI["APPVEYOR"]

CI is running on AppVeyor

var AZURE_PIPELINES = vendorsIsCI["AZURE_PIPELINES"]

CI is running on Azure Pipelines

var BAMBOO = vendorsIsCI["BAMBOO"]

CI is running on Bamboo

var BITBUCKET = vendorsIsCI["BITBUCKET"]

CI is running on Bitbucket Pipelines

var BITRISE = vendorsIsCI["BITRISE"]

CI is running on Bitrise

var BUDDY = vendorsIsCI["BUDDY"]

CI is running on Buddy

var BUILDKITE = vendorsIsCI["BUILDKITE"]

CI is running on Buildkite

var CIRCLE = vendorsIsCI["CIRCLE"]

CI is running on CircleCI

var CIRRUS = vendorsIsCI["CIRRUS"]

CI is running on Cirrus CI

var CODEBUILD = vendorsIsCI["CODEBUILD"]

CI is running on AWS CodeBuild

var CODEFRESH = vendorsIsCI["CODEFRESH"]

CI is running on Codefresh

var CODEMAGIC = vendorsIsCI["CODEMAGIC"]

CI is running on Codemagic

var CODESHIP = vendorsIsCI["CODESHIP"]

CI is running on Codeship

var DRONE = vendorsIsCI["DRONE"]

CI is running on Drone

var DSARI = vendorsIsCI["DSARI"]

CI is running on dsari

var EARTHLY = vendorsIsCI["EARTHLY"]

CI is running on Earthly

var EAS = vendorsIsCI["EAS"]

CI is running on Expo Application Services

var GERRIT = vendorsIsCI["GERRIT"]

CI is running on Gerrit

var GITEA_ACTIONS = vendorsIsCI["GITEA_ACTIONS"]

CI is running on Gitea Actions

var GITHUB_ACTIONS = vendorsIsCI["GITHUB_ACTIONS"]

CI is running on GitHub Actions

var GITLAB = vendorsIsCI["GITLAB"]

CI is running on GitLab CI

var GOCD = vendorsIsCI["GOCD"]

CI is running on GoCD

var GOOGLE_CLOUD_BUILD = vendorsIsCI["GOOGLE_CLOUD_BUILD"]

CI is running on Google Cloud Build

var HARNESS = vendorsIsCI["HARNESS"]

CI is running on Harness CI

var HEROKU = vendorsIsCI["HEROKU"]

CI is running on Heroku

var HUDSON = vendorsIsCI["HUDSON"]

CI is running on Hudson

var JENKINS = vendorsIsCI["JENKINS"]

CI is running on Jenkins

var LAYERCI = vendorsIsCI["LAYERCI"]

CI is running on LayerCI

var MAGNUM = vendorsIsCI["MAGNUM"]

CI is running on Magnum CI

var NETLIFY = vendorsIsCI["NETLIFY"]

CI is running on Netlify CI

var NEVERCODE = vendorsIsCI["NEVERCODE"]

CI is running on Nevercode

var PROW = vendorsIsCI["PROW"]

CI is running on Prow

var RELEASEHUB = vendorsIsCI["RELEASEHUB"]

CI is running on ReleaseHub

var RENDER = vendorsIsCI["RENDER"]

CI is running on Render

var SAIL = vendorsIsCI["SAIL"]

CI is running on Sail CI

var SCREWDRIVER = vendorsIsCI["SCREWDRIVER"]

CI is running on Screwdriver

var SEMAPHORE = vendorsIsCI["SEMAPHORE"]

CI is running on Semaphore

var SOURCEHUT = vendorsIsCI["SOURCEHUT"]

CI is running on Sourcehut

var STRIDER = vendorsIsCI["STRIDER"]

CI is running on Strider CD

var TASKCLUSTER = vendorsIsCI["TASKCLUSTER"]

CI is running on TaskCluster

var TEAMCITY = vendorsIsCI["TEAMCITY"]

CI is running on TeamCity

var TRAVIS = vendorsIsCI["TRAVIS"]

CI is running on Travis CI

var VELA = vendorsIsCI["VELA"]

CI is running on Vela

var VERCEL = vendorsIsCI["VERCEL"]

CI is running on Vercel

var WOODPECKER = vendorsIsCI["WOODPECKER"]

CI is running on Woodpecker

var XCODE_CLOUD = vendorsIsCI["XCODE_CLOUD"]

CI is running on Xcode Cloud

var XCODE_SERVER = vendorsIsCI["XCODE_SERVER"]

CI is running on Xcode Server

Functions

func IsVendor

func IsVendor(vendor string) bool