feat(gatsby-core-utils): Add isCI and getCIName (#19039)

Fixes #19018

Author: RobinCsl

packages/gatsby-cli/package.json

@@ -16,7 +16,6 @@
     "better-opn": "^0.1.4",
     "bluebird": "^3.7.1",
     "chalk": "^2.4.2",
-    "ci-info": "^2.0.0",
     "clipboardy": "^2.1.0",
     "common-tags": "^1.8.0",
     "configstore": "^5.0.0",
@@ -26,6 +25,7 @@
     "execa": "^2.1.0",
     "fs-exists-cached": "^1.0.0",
     "fs-extra": "^8.1.0",
+    "gatsby-core-utils": "^1.0.15",
     "gatsby-telemetry": "^1.1.34",
     "hosted-git-info": "^3.0.2",
     "is-valid-path": "^0.1.1",

packages/gatsby-cli/src/reporter/index.js

@@ -1,7 +1,7 @@
 // @flow
 
 const semver = require(`semver`)
-const { isCI } = require(`ci-info`)
+const { isCI } = require(`gatsby-core-utils`)
 const signalExit = require(`signal-exit`)
 const reporterActions = require(`./redux/actions`)
 
@@ -17,7 +17,7 @@ if (!process.env.GATSBY_LOGGER) {
   if (
     inkExists &&
     semver.satisfies(process.version, `>=8`) &&
-    !isCI &&
+    !isCI() &&
     typeof jest === `undefined`
   ) {
     process.env.GATSBY_LOGGER = `ink`

packages/gatsby-cli/src/util/__tests__/is-tty.js

@@ -11,35 +11,35 @@ describe(`isTTY`, () => {
 
   it(`returns true if not on ci & TTY is enabled`, () => {
     process.stdout.isTTY = true
-    jest.mock(`ci-info`, () => {
-      return { isCI: false }
+    jest.mock(`gatsby-core-utils`, () => {
+      return { isCI: () => false }
     })
     const isTTY = require(`../is-tty`)
     expect(isTTY()).toBe(true)
   })
 
   it(`returns false if not on ci & TTY is disabled`, () => {
     process.stdout.isTTY = false
-    jest.mock(`ci-info`, () => {
-      return { isCI: false }
+    jest.mock(`gatsby-core-utils`, () => {
+      return { isCI: () => false }
     })
     const isTTY = require(`../is-tty`)
     expect(isTTY()).toBe(false)
   })
 
   it(`returns false if on ci & TTY is enabled`, () => {
     process.stdout.isTTY = true
-    jest.mock(`ci-info`, () => {
-      return { isCI: true }
+    jest.mock(`gatsby-core-utils`, () => {
+      return { isCI: () => true }
     })
     const isTTY = require(`../is-tty`)
     expect(isTTY()).toBe(false)
   })
 
   it(`returns false if on ci & TTY is disabled`, () => {
     process.stdout.isTTY = false
-    jest.mock(`ci-info`, () => {
-      return { isCI: true }
+    jest.mock(`gatsby-core-utils`, () => {
+      return { isCI: () => true }
     })
     const isTTY = require(`../is-tty`)
     expect(isTTY()).toBe(false)

packages/gatsby-cli/src/util/is-tty.js

@@ -1,6 +1,6 @@
-const isCI = require(`ci-info`).isCI
+const { isCI } = require(`gatsby-core-utils`)
 
 // Some CI pipelines incorrectly report process.stdout.isTTY status,
 // which causes unwanted lines in the output. An additional check for isCI helps.
 // @see https://github.com/prettier/prettier/blob/36aeb4ce4f620023c8174e826d7208c0c64f1a0b/src/utils/is-tty.js
-module.exports = () => process.stdout.isTTY && !isCI
+module.exports = () => process.stdout.isTTY && !isCI()

packages/gatsby-core-utils/README.md

@@ -63,3 +63,30 @@ const pathname = "./gatsby/is/awesome"
 const url = joinPath(BASEPATH, pathname)
 // ...
 ```
+
+### isCI
+
+A utility that enhances `isCI` from 'ci-info` with support for ZEIT's Now and Heroku detection
+
+```js
+const { isCI } = require("gatsby-core-utils")
+
+if (isCI()) {
+  // execute CI-specific code
+}
+// ...
+```
+
+### getCIName
+
+A utility that returns the name of the current CI environment if available, `null` otherwise
+
+```js
+const { getCIName } = require("gatsby-core-utils")
+
+const CI_NAME = getCIName()
+console.log({ CI_NAME })
+// {CI_NAME: null}, or
+// {CI_NAME: "ZEIT Now"}
+// ...
+```

packages/gatsby-core-utils/index.d.ts

@@ -31,3 +31,15 @@ export declare function cpuCoreCount(ignoreEnvVar?: boolean): number
  * @param {string[]} segments A sequence of segments
  */
 export declare function urlResolve(...segments: string[]): string
+
+/**
+ * Determines whether the environment where the code is running is in CI
+ * @return {boolean} true if the environment is in CI, false otherwise
+ */
+export declare function isCI(): boolean
+
+/**
+ * Gets the name of the CI environment (e.g. "ZEIT Now", "Heroku", etc.)
+ * @return {string | null} The name of the CI if available. Defaults to null if not in CI
+ */
+export declare function getCIName(): string | null

packages/gatsby-core-utils/package.json

@@ -28,6 +28,9 @@
     "index.d.ts"
   ],
   "types": "index.d.ts",
+  "dependencies": {
+    "ci-info": "2.0.0"
+  },
   "devDependencies": {
     "@babel/cli": "^7.6.4",
     "@babel/core": "^7.6.4",