fix: use ci-detect instead of isCI

package.json

@@ -55,6 +55,7 @@
     "@actions/exec": "^1.1.1",
     "@actions/io": "^1.1.2",
     "@actions/tool-cache": "^2.0.1",
+    "@npmcli/ci-detect": "^2.0.0",
     "escape-path-with-spaces": "^1.0.0",
     "exec-powershell": "workspace:*",
     "execa": "^5.1.1",

pnpm-lock.yaml

@@ -16,6 +16,7 @@ importers:
       '@actions/exec': ^1.1.1
       '@actions/io': ^1.1.2
       '@actions/tool-cache': ^2.0.1
+      '@npmcli/ci-detect': ^2.0.0
       '@types/cross-spawn': ^6.0.2
       '@types/jest': ^28.1.6
       '@types/mri': ^1.1.1
@@ -61,6 +62,7 @@ importers:
       '@actions/exec': 1.1.1
       '@actions/io': 1.1.2
       '@actions/tool-cache': 2.0.1
+      '@npmcli/ci-detect': 2.0.0
       escape-path-with-spaces: 1.0.0
       exec-powershell: link:packages/exec-powershell
       execa: 5.1.1
@@ -1378,6 +1380,11 @@ packages:
       fastq: 1.13.0
     dev: true
 
+  /@npmcli/ci-detect/2.0.0:
+    resolution: {integrity: sha512-8yQtQ9ArHh/TzdUDKQwEvwCgpDuhSWTDAbiKMl3854PcT+Dk4UmWaiawuFTLy9n5twzXOBXVflWe+90/ffXQrA==}
+    engines: {node: ^12.13.0 || ^14.15.0 || >=16}
+    dev: false
+
   /@npmcli/fs/2.1.1:
     resolution: {integrity: sha512-1Q0uzx6c/NVNGszePbr5Gc2riSU1zLpNlo/1YWntH+eaPmMgBssAW0qXofCVkpdj3ce4swZtlDYQu+NKiYcptg==}
     engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0}

src/cmake/__tests__/cmake.test.ts

@@ -1,6 +1,6 @@
 import { setupCmake } from "../cmake"
 import { setupTmpDir, cleanupTmpDir, testBin } from "../../utils/tests/test-helpers"
-import { isGitHubCI } from "../../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { getVersion } from "../../default_versions"
 
 jest.setTimeout(300000)
@@ -19,7 +19,7 @@ describe("setup-cmake", () => {
   it("should find CMake in the cache", async () => {
     const { binDir } = await setupCmake(getVersion("cmake", "true"), directory, process.arch)
     await testBin("cmake", ["--version"], binDir)
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       expect(binDir).toMatch(process.env.RUNNER_TOOL_CACHE ?? "hostedtoolcache")
     }
   })

src/gcc/gcc.ts

@@ -9,7 +9,7 @@ import semverCoerce from "semver/functions/coerce"
 import { setupMacOSSDK } from "../macos-sdk/macos-sdk"
 import path from "path"
 import { warning, info } from "../utils/io/io"
-import { isGitHubCI } from "../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { addBinExtension } from "extension-tools"
 import { InstallationInfo, PackageInfo, setupBin } from "../utils/setup/setupBin"
 import { extract7Zip } from "../utils/setup/extract"
@@ -186,7 +186,7 @@ async function activateGcc(version: string, binDir: string) {
 
   promises.push(setupMacOSSDK())
 
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     addGccLoggingMatcher()
   }
 

src/kcov/__tests__/kcov.test.ts

@@ -39,7 +39,7 @@ describe("setup-Kcov", () => {
 
   // it("should find Kcov in the cache", async () => {
   //   const binDir = await testKcov("v39", directory)
-  //   if (isGitHubCI()) {
+  //   if (ciDetect() === "github") {
   //     expect(binDir).toMatch(process.env.RUNNER_TOOL_CACHE ?? "hostedtoolcache")
   //   }
   //   await cleanupTmpDir("kcov-v39")

src/llvm/__tests__/llvm.test.ts

@@ -2,7 +2,7 @@ import { setupLLVM, VERSIONS, getUrl, setupClangTools, getLinuxUrl } from "../ll
 import { getSpecificVersionAndUrl } from "../../utils/setup/version"
 import { isValidUrl } from "../../utils/http/validate_url"
 import { setupTmpDir, cleanupTmpDir, testBin } from "../../utils/tests/test-helpers"
-import { isGitHubCI } from "../../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import execa from "execa"
 import path from "path"
 import { addBinExtension } from "extension-tools"
@@ -101,7 +101,7 @@ describe("setup-llvm", () => {
     const { binDir } = await setupLLVM(getVersion("llvm", "true", osVersion), directory, process.arch)
     await testBin("clang++", ["--version"], binDir)
 
-    if (isGitHubCI() && process.platform !== "linux") {
+    if (ciDetect() === "github" && process.platform !== "linux") {
       expect(binDir).toMatch(process.env.RUNNER_TOOL_CACHE ?? "hostedtoolcache")
       // TODO returns the install dir on linux
     }
@@ -109,7 +109,7 @@ describe("setup-llvm", () => {
     expect(process.env.CC?.includes("clang")).toBeTruthy()
     expect(process.env.CXX?.includes("clang++")).toBeTruthy()
 
-    if (isGitHubCI() && process.platform !== "linux") {
+    if (ciDetect() === "github" && process.platform !== "linux") {
       expect(process.env.CC).toMatch("hostedtoolcache")
       expect(process.env.CXX).toMatch("hostedtoolcache")
     }

src/llvm/llvm.ts

@@ -17,7 +17,7 @@ import { setOutput } from "@actions/core"
 import { setupAptPack, updateAptAlternatives } from "../utils/setup/setupAptPack"
 import { info, warning } from "../utils/io/io"
 import { existsSync } from "fs"
-import { isGitHubCI } from "../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { setupGcc } from "../gcc/gcc"
 import { getVersion } from "../default_versions"
 import { isArch } from "../utils/env/isArch"
@@ -353,7 +353,7 @@ export async function activateLLVM(directory: string, versionGiven: string) {
     updateAptAlternatives("llvm-ar", `${directory}/bin/llvm-ar`)
   }
 
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     addLLVMLoggingMatcher()
   }
 
@@ -362,7 +362,7 @@ export async function activateLLVM(directory: string, versionGiven: string) {
 
 /** Setup llvm tools (clang tidy, clang format, etc) without activating llvm and using it as the compiler */
 export function setupClangTools(version: string, setupDir: string, arch: string): Promise<InstallationInfo> {
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     addLLVMLoggingMatcher()
   }
   return _setupLLVM(version, setupDir, arch)

src/main.ts

@@ -17,7 +17,7 @@ import { setupOpencppcoverage } from "./opencppcoverage/opencppcoverage"
 import { setupPython } from "./python/python"
 import mri from "mri"
 import { untildify_user as untildify } from "./utils/path/untildify"
-import { isGitHubCI } from "./utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import * as timeDelta from "time-delta"
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
@@ -113,7 +113,7 @@ const inputs: Array<Inputs> = ["compiler", "architecture", ...tools]
 
 /** The main entry function */
 export async function main(args: string[]): Promise<number> {
-  if (!isGitHubCI()) {
+  if (ciDetect() !== "github") {
     process.env.ACTIONS_ALLOW_UNSECURE_COMMANDS = "true"
   }
 
@@ -281,7 +281,7 @@ export async function main(args: string[]): Promise<number> {
 
   info("setup_cpp finished")
 
-  if (!isGitHubCI()) {
+  if (ciDetect() !== "github") {
     switch (process.platform) {
       case "win32": {
         warning("Run `RefreshEnv.cmd` or restart your shell to update the environment.")

src/msvc/msvc.ts

@@ -3,7 +3,7 @@ import { setupVCVarsall } from "../vcvarsall/vcvarsall"
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { vsversion_to_versionnumber, findVcvarsall } from "msvc-dev-cmd/lib.js"
-import { isGitHubCI } from "../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import path from "path"
 import { existsSync } from "fs"
 import { error, info, warning } from "../utils/io/io"
@@ -65,7 +65,7 @@ export async function setupMSVC(
   // run vcvarsall.bat environment variables
   await setupVCVarsall(version, VCTargetsPath, arch, toolset, sdk, uwp, spectre)
 
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     addMSVCLoggingMatcher()
   }
 }

src/ninja/__tests__/ninja.test.ts

@@ -1,6 +1,6 @@
 import { setupNinja } from "../ninja"
 import { setupTmpDir, cleanupTmpDir, testBin } from "../../utils/tests/test-helpers"
-import { isGitHubCI } from "../../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { getVersion } from "../../default_versions"
 
 jest.setTimeout(300000)
@@ -22,7 +22,7 @@ describe("setup-ninja", () => {
 
   it("should find Ninja in the cache", async () => {
     const binDir = await testNinja(directory)
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       expect(binDir).toMatch(process.env.RUNNER_TOOL_CACHE ?? "hostedtoolcache")
     }
   })

src/python/__tests__/python.test.ts

@@ -2,7 +2,7 @@ import { setupPython } from "../python"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import { getVersion } from "../../default_versions"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
-import { isGitHubCI } from "../../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { info } from "../../utils/io/io"
 
 jest.setTimeout(300000)
@@ -13,7 +13,7 @@ describe("setup-python", () => {
   })
 
   it("should setup python in GitHub Actions", async () => {
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       info("Installing python in GitHub Actions")
       const { setupActionsPython } = await import("../actions_python")
       await setupActionsPython(getVersion("python", "true", await ubuntuVersion()), directory, process.arch)

src/python/actions_python.ts

@@ -4,7 +4,7 @@ import { existsSync } from "fs"
 import { info, warning } from "../utils/io/io"
 import { debug } from "@actions/core"
 import path from "path"
-import { isGitHubCI } from "../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { isCacheFeatureAvailable, IS_LINUX, IS_WINDOWS } from "setup-python/src/utils"
 import { getCacheDistributor } from "setup-python/src/cache-distributions/cache-factory"
 
@@ -72,7 +72,7 @@ export async function setupActionsPython(version: string, _setupDir: string, arc
     }
   }
 
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     addPythonLoggingMatcher()
   }
 

src/python/python.ts

@@ -3,7 +3,7 @@ import { setupAptPack } from "../utils/setup/setupAptPack"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack"
 import { setupBrewPack } from "../utils/setup/setupBrewPack"
 import { setupChocoPack } from "../utils/setup/setupChocoPack"
-import { isGitHubCI } from "../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { warning, info } from "../utils/io/io"
 import { isArch } from "../utils/env/isArch"
 import which from "which"
@@ -14,7 +14,7 @@ import { setupDnfPack } from "../utils/setup/setupDnfPack"
 import { isUbuntu } from "../utils/env/isUbuntu"
 
 export async function setupPython(version: string, setupDir: string, arch: string) {
-  if (!isGitHubCI()) {
+  if (ciDetect() !== "github") {
     // TODO parse version
     return setupPythonViaSystem(version, setupDir, arch)
   }

src/task/__tests__/task.test.ts

@@ -1,6 +1,6 @@
 import { setupTask } from "../task"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
-import { isGitHubCI } from "../../utils/env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { getVersion } from "../../default_versions"
 
 jest.setTimeout(300000)
@@ -18,7 +18,7 @@ describe("setup-task", () => {
 
   it("should find task in the cache", async () => {
     const { binDir } = await setupTask(getVersion("task", "true"), directory, process.arch)
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       expect(binDir).toMatch(process.env.RUNNER_TOOL_CACHE ?? "hostedtoolcache")
     }
   })

src/types.d.ts

@@ -0,0 +1,56 @@
+declare module "@npmcli/ci-detect" {
+  /**
+   * Returns one of the following strings, or `false` if none match, by looking at the appropriate environment variables.
+   *
+   * - `'gerrit'` Gerrit
+   * - `'gitlab'` GitLab
+   * - `'circleci'` Circle-CI
+   * - `'semaphore'` Semaphore
+   * - `'drone'` Drone
+   * - `'github-actions'` GitHub Actions
+   * - `'tddium'` TDDium
+   * - `'jenkins'` Jenkins
+   * - `'bamboo'` Bamboo
+   * - `'gocd'` GoCD
+   * - `'wercker'` Oracle Wercker
+   * - `'netlify'` Netlify
+   * - `'now-github'` Zeit.co's Now for GitHub deployment service
+   * - `'now-bitbucket'` Zeit.co's Now for BitBucket deployment service
+   * - `'now-gitlab'` Zeit.co's Now for GitLab deployment service
+   * - `'now'` Zeit.co's Now service, but not GitHub/BitBucket/GitLab
+   * - `'azure-pipelines'` Azure Pipelines
+   * - `'bitbucket-pipelines'` Bitbucket Pipelines
+   * - `'bitrise'` Bitrise
+   * - `'buddy'` Buddy
+   * - `'buildkite'` Buildkite
+   * - `'cirrus'` Cirrus CI
+   * - `'dsari'` dsari CI
+   * - `'screwdriver'` Screwdriver CI
+   * - `'strider'` Strider CI
+   * - `'taskcluster'` Mozilla Taskcluster
+   * - `'hudson'` Hudson CI
+   * - `'magnum'` Magnum CI
+   * - `'nevercode'` Nevercode
+   * - `'render'` Render CI
+   * - `'sail'` Sail CI
+   * - `'shippable'` Shippable
+   * - `'heroku'` Heroku
+   * - `'codeship'` CodeShip
+   * - `'teamcity'` TeamCity
+   * - `'vercel'` Vercel
+   * - `'vercel-github'` Vercel GitHub
+   * - `'vercel-gitlab'` Vercel Gitlab
+   * - `'vercel-bitbucket'` Vercel Bitbucket
+   * - Anything that sets the `CI_NAME` environment variable will return the value as the result. (This is how CodeShip is
+   *   detected.)
+   * - `'travis-ci'` Travis-CI - A few other CI systems set `TRAVIS=1` in the environment, because devs use that to
+   *   indicate "test mode", so this one can get some false positives, and is tested later in the process to minimize
+   *   this effect.
+   * - `'aws-codebuild'` AWS CodeBuild
+   * - `'builder'` Google Cloud Builder - This one is a bit weird. It doesn't really set anything that can be reliably
+   *   detected except `BUILDER_OUTPUT`, so it can get false positives pretty easily.
+   * - `'custom'` anything else that sets `CI` environment variable to either `'1'` or `'true'`.
+   */
+  function ciDetect(): string | boolean
+  export = ciDetect
+}

src/utils/env/addEnv.ts

@@ -1,5 +1,5 @@
 import { exportVariable, addPath as ghAddPath, info, setFailed } from "@actions/core"
-import { isGitHubCI } from "./isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { untildify_user as untildify } from "../path/untildify"
 import { appendFileSync, existsSync, readFileSync } from "fs"
 import { error, warning } from "../io/io"
@@ -15,7 +15,7 @@ import { escapeSpace } from "../path/escape_space"
 export async function addEnv(name: string, valGiven: string | undefined, shouldEscapeSpace: boolean = false) {
   const val = shouldEscapeSpace ? escapeSpace(valGiven) : valGiven
   try {
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       try {
         exportVariable(name, val)
       } catch (err) {
@@ -39,7 +39,7 @@ export async function addEnv(name: string, valGiven: string | undefined, shouldE
 export async function addPath(path: string) {
   process.env.PATH = `${path}${delimiter}${process.env.PATH}`
   try {
-    if (isGitHubCI()) {
+    if (ciDetect() === "github") {
       try {
         ghAddPath(path)
       } catch (err) {

src/utils/env/isCI.ts

@@ -1,7 +0,0 @@
-export function isCI() {
-  return process.env.CI === "true"
-}
-
-export function isGitHubCI() {
-  return isCI() && process.env.GITHUB_ACTIONS === "true"
-}

src/utils/io/io.ts

@@ -1,8 +1,8 @@
 import * as core from "@actions/core"
-import { isGitHubCI } from "../env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 
 export function error(err: string | Error) {
-  return isGitHubCI() ? core.error(err) : console.log(`\x1b[31m${err}\x1b[0m`)
+  return ciDetect() === "github" ? core.error(err) : console.log(`\x1b[31m${err}\x1b[0m`)
 }
 
 export function success(msg: string) {
@@ -10,13 +10,13 @@ export function success(msg: string) {
 }
 
 export function warning(msg: string) {
-  return isGitHubCI() ? core.warning(msg) : console.log(`\x1b[33m${msg}\x1b[0m`)
+  return ciDetect() === "github" ? core.warning(msg) : console.log(`\x1b[33m${msg}\x1b[0m`)
 }
 
 export function notice(msg: string) {
-  return isGitHubCI() ? core.notice(msg) : console.log(`\x1b[94m${msg}\x1b[0m`)
+  return ciDetect() === "github" ? core.notice(msg) : console.log(`\x1b[94m${msg}\x1b[0m`)
 }
 
 export function info(msg: string) {
-  return isGitHubCI() ? core.info(msg) : console.log(msg)
+  return ciDetect() === "github" ? core.info(msg) : console.log(msg)
 }

src/utils/setup/setupAptPack.ts

@@ -2,7 +2,7 @@
 import { InstallationInfo } from "./setupBin"
 import { execRootSync } from "root-tools"
 import { info } from "@actions/core"
-import { isGitHubCI } from "../env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { addEnv, cpprc_path, setupCppInProfile } from "../env/addEnv"
 import { appendFileSync, existsSync } from "fs"
 import which from "which"
@@ -124,7 +124,7 @@ export async function addAptKeyViaDownload(name: string, url: string) {
 }
 
 export function updateAptAlternatives(name: string, path: string) {
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     return execRootSync("update-alternatives", ["--install", `/usr/bin/${name}`, name, path, "40"])
   } else {
     setupCppInProfile()

src/utils/setup/setupBin.ts

@@ -4,7 +4,7 @@ import { addPath } from "../env/addEnv"
 import { join } from "path"
 import { existsSync } from "fs"
 import { tmpdir } from "os"
-import { isGitHubCI } from "../env/isCI"
+import ciDetect from "@npmcli/ci-detect"
 import { setupAptPack } from "./setupAptPack"
 import { setupPacmanPack } from "./setupPacmanPack"
 import { isArch } from "../env/isArch"
@@ -64,7 +64,7 @@ export async function setupBin(
   )
 
   // Restore from cache (if found).
-  if (isGitHubCI()) {
+  if (ciDetect() === "github") {
     try {
       const dir = find(name, version)
       if (dir) {
@@ -129,7 +129,7 @@ export async function setupBin(
   await addPath(binDir)
 
   // check if inside Github Actions. If so, cache the installation
-  if (isGitHubCI() && typeof process.env.RUNNER_TOOL_CACHE === "string") {
+  if (ciDetect() === "github" && typeof process.env.RUNNER_TOOL_CACHE === "string") {
     await cacheDir(setupDir, name, version)
   }