ci-info

  • Version 4.4.0
  • Published
  • 30 kB
  • No dependencies
  • MIT license

Install

npm i ci-info
yarn add ci-info
pnpm add ci-info

Overview

Get details about the current Continuous Integration environment

Index

Variables

variable AGOLA

const AGOLA: boolean;

    variable ALPIC

    const ALPIC: boolean;

      variable APPCENTER

      const APPCENTER: boolean;

        variable APPCIRCLE

        const APPCIRCLE: boolean;

          variable APPVEYOR

          const APPVEYOR: boolean;

            variable AZURE_PIPELINES

            const AZURE_PIPELINES: boolean;

              variable BAMBOO

              const BAMBOO: boolean;

                variable BITBUCKET

                const BITBUCKET: boolean;

                  variable BITRISE

                  const BITRISE: boolean;

                    variable BUDDY

                    const BUDDY: boolean;

                      variable BUILDKITE

                      const BUILDKITE: boolean;

                        variable CIRCLE

                        const CIRCLE: boolean;

                          variable CIRRUS

                          const CIRRUS: boolean;

                            variable CLOUDFLARE_PAGES

                            const CLOUDFLARE_PAGES: boolean;

                              variable CLOUDFLARE_WORKERS

                              const CLOUDFLARE_WORKERS: boolean;

                                variable CODEBUILD

                                const CODEBUILD: boolean;

                                  variable CODEFRESH

                                  const CODEFRESH: boolean;

                                    variable CODEMAGIC

                                    const CODEMAGIC: boolean;

                                      variable CODESHIP

                                      const CODESHIP: boolean;

                                        variable DRONE

                                        const DRONE: boolean;

                                          variable DSARI

                                          const DSARI: boolean;

                                            variable EARTHLY

                                            const EARTHLY: boolean;

                                              variable EAS

                                              const EAS: boolean;

                                                variable GERRIT

                                                const GERRIT: boolean;

                                                  variable GITEA_ACTIONS

                                                  const GITEA_ACTIONS: boolean;

                                                    variable GITHUB_ACTIONS

                                                    const GITHUB_ACTIONS: boolean;

                                                      variable GITLAB

                                                      const GITLAB: boolean;

                                                        variable GOCD

                                                        const GOCD: boolean;

                                                          variable GOOGLE_CLOUD_BUILD

                                                          const GOOGLE_CLOUD_BUILD: boolean;

                                                            variable HARNESS

                                                            const HARNESS: boolean;

                                                              variable HEROKU

                                                              const HEROKU: boolean;

                                                                variable HUDSON

                                                                const HUDSON: boolean;

                                                                  variable id

                                                                  const id: string;
                                                                  • Returns a string containing the identifier of the CI server the code is running on. If CI server is not detected, it returns null.

                                                                  variable isCI

                                                                  const isCI: boolean;
                                                                  • 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 ci.isCI boolean to be set to true if they use certain vendor neutral environment variables. In those cases ci.name will be null and no vendor specific boolean will be set to true.

                                                                  variable isPR

                                                                  const isPR: boolean;
                                                                  • 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 null.

                                                                  variable JENKINS

                                                                  const JENKINS: boolean;

                                                                    variable LAYERCI

                                                                    const LAYERCI: boolean;

                                                                      variable MAGNUM

                                                                      const MAGNUM: boolean;

                                                                        variable name

                                                                        const name: string;
                                                                        • Returns a string containing name of the CI server the code is running on. If CI server is not detected, it returns null.

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

                                                                        variable NETLIFY

                                                                        const NETLIFY: boolean;

                                                                          variable NEVERCODE

                                                                          const NEVERCODE: boolean;

                                                                            variable PROW

                                                                            const PROW: boolean;

                                                                              variable RELEASEHUB

                                                                              const RELEASEHUB: boolean;

                                                                                variable RENDER

                                                                                const RENDER: boolean;

                                                                                  variable SAIL

                                                                                  const SAIL: boolean;

                                                                                    variable SCREWDRIVER

                                                                                    const SCREWDRIVER: boolean;

                                                                                      variable SEMAPHORE

                                                                                      const SEMAPHORE: boolean;

                                                                                        variable SOURCEHUT

                                                                                        const SOURCEHUT: boolean;

                                                                                          variable STRIDER

                                                                                          const STRIDER: boolean;

                                                                                            variable TASKCLUSTER

                                                                                            const TASKCLUSTER: boolean;

                                                                                              variable TEAMCITY

                                                                                              const TEAMCITY: boolean;

                                                                                                variable TRAVIS

                                                                                                const TRAVIS: boolean;

                                                                                                  variable VELA

                                                                                                  const VELA: boolean;

                                                                                                    variable VERCEL

                                                                                                    const VERCEL: boolean;

                                                                                                      variable WOODPECKER

                                                                                                      const WOODPECKER: boolean;

                                                                                                        variable XCODE_CLOUD

                                                                                                        const XCODE_CLOUD: boolean;

                                                                                                          variable XCODE_SERVER

                                                                                                          const XCODE_SERVER: boolean;

                                                                                                            Package Files (1)

                                                                                                            Dependencies (0)

                                                                                                            No dependencies.

                                                                                                            Dev Dependencies (5)

                                                                                                            Peer Dependencies (0)

                                                                                                            No peer dependencies.

                                                                                                            Badge

                                                                                                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ci-info.

                                                                                                            • Markdown
                                                                                                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ci-info)
                                                                                                            • HTML
                                                                                                              <a href="https://www.jsdocs.io/package/ci-info"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>