Skip to content

Commit

Permalink
deps: move from @npmcli/ci-detect to ci-info (#5858)
Browse files Browse the repository at this point in the history
See watson/ci-info#95 for more context on
achieving parity between these two modules.

This changes npm to use `ci-info` instead of `@npmcli/ci-detect`.
Everything that npm currently flags as a CI environment should still be
doing so, so there is no breaking change there.

There is going to be a subtle difference in the `ci-name` config, which
nothing in npm currently looks at anyways, as well as the ci name that
shows up in the default `user-agent` string.  Some providers will be
slightly different (i.e. circle-ci vs circleci and cirrus vs cirrus-ci)
  • Loading branch information
wraithgar committed Nov 16, 2022
1 parent 3f13818 commit a351685
Show file tree
Hide file tree
Showing 24 changed files with 515 additions and 167 deletions.
8 changes: 3 additions & 5 deletions DEPENDENCIES.md
Expand Up @@ -32,7 +32,6 @@ graph LR;
libnpmexec-->minify-registry-metadata;
libnpmexec-->npm-package-arg;
libnpmexec-->npmcli-arborist["@npmcli/arborist"];
libnpmexec-->npmcli-ci-detect["@npmcli/ci-detect"];
libnpmexec-->npmcli-eslint-config["@npmcli/eslint-config"];
libnpmexec-->npmcli-run-script["@npmcli/run-script"];
libnpmexec-->npmcli-template-oss["@npmcli/template-oss"];
Expand Down Expand Up @@ -113,7 +112,6 @@ graph LR;
npm-->npm-registry-fetch;
npm-->npm-user-validate;
npm-->npmcli-arborist["@npmcli/arborist"];
npm-->npmcli-ci-detect["@npmcli/ci-detect"];
npm-->npmcli-config["@npmcli/config"];
npm-->npmcli-docs["@npmcli/docs"];
npm-->npmcli-eslint-config["@npmcli/eslint-config"];
Expand Down Expand Up @@ -353,11 +351,11 @@ graph LR;
libnpmdiff-->tar;
libnpmexec-->bin-links;
libnpmexec-->chalk;
libnpmexec-->ci-info;
libnpmexec-->minify-registry-metadata;
libnpmexec-->mkdirp;
libnpmexec-->npm-package-arg;
libnpmexec-->npmcli-arborist["@npmcli/arborist"];
libnpmexec-->npmcli-ci-detect["@npmcli/ci-detect"];
libnpmexec-->npmcli-eslint-config["@npmcli/eslint-config"];
libnpmexec-->npmcli-run-script["@npmcli/run-script"];
libnpmexec-->npmcli-template-oss["@npmcli/template-oss"];
Expand Down Expand Up @@ -476,6 +474,7 @@ graph LR;
npm-->archy;
npm-->cacache;
npm-->chalk;
npm-->ci-info;
npm-->cli-columns;
npm-->cli-table3;
npm-->columnify;
Expand Down Expand Up @@ -519,7 +518,6 @@ graph LR;
npm-->npm-registry-fetch;
npm-->npm-user-validate;
npm-->npmcli-arborist["@npmcli/arborist"];
npm-->npmcli-ci-detect["@npmcli/ci-detect"];
npm-->npmcli-config["@npmcli/config"];
npm-->npmcli-docs["@npmcli/docs"];
npm-->npmcli-eslint-config["@npmcli/eslint-config"];
Expand Down Expand Up @@ -783,4 +781,4 @@ packages higher up the chain.
- @npmcli/git, make-fetch-happen, @npmcli/config, init-package-json
- @npmcli/installed-package-contents, @npmcli/map-workspaces, cacache, npm-pick-manifest, @npmcli/run-script, read-package-json, promzard
- @npmcli/docs, @npmcli/fs, npm-bundled, read-package-json-fast, unique-filename, npm-install-checks, npm-package-arg, npm-packlist, normalize-package-data, @npmcli/package-json, bin-links, nopt, npmlog, parse-conflict-json, read
- @npmcli/eslint-config, @npmcli/template-oss, ignore-walk, semver, npm-normalize-package-bin, @npmcli/name-from-folder, json-parse-even-better-errors, fs-minipass, ssri, unique-slug, @npmcli/promise-spawn, hosted-git-info, proc-log, validate-npm-package-name, @npmcli/node-gyp, minipass-fetch, @npmcli/query, cmd-shim, read-cmd-shim, write-file-atomic, abbrev, are-we-there-yet, gauge, treeverse, minify-registry-metadata, ini, @npmcli/disparity-colors, @npmcli/ci-detect, mute-stream, npm-audit-report, npm-user-validate
- @npmcli/eslint-config, @npmcli/template-oss, ignore-walk, semver, npm-normalize-package-bin, @npmcli/name-from-folder, json-parse-even-better-errors, fs-minipass, ssri, unique-slug, @npmcli/promise-spawn, hosted-git-info, proc-log, validate-npm-package-name, @npmcli/node-gyp, minipass-fetch, @npmcli/query, cmd-shim, read-cmd-shim, write-file-atomic, abbrev, are-we-there-yet, gauge, treeverse, minify-registry-metadata, ini, @npmcli/disparity-colors, mute-stream, npm-audit-report, npm-user-validate
9 changes: 4 additions & 5 deletions lib/utils/config/definitions.js
Expand Up @@ -4,8 +4,7 @@ module.exports = definitions
const Definition = require('./definition.js')

const { version: npmVersion } = require('../../../package.json')
const ciDetect = require('@npmcli/ci-detect')
const ciName = ciDetect()
const ciInfo = require('ci-info')
const querystring = require('querystring')
const { isWindows } = require('../is-windows.js')
const { join } = require('path')
Expand Down Expand Up @@ -433,7 +432,7 @@ define('cert', {
})

define('ci-name', {
default: ciName || null,
default: ciInfo.name ? ciInfo.name.toLowerCase().split(' ').join('-') : null,
defaultDescription: `
The name of the current CI system, or \`null\` when not on a known CI
platform.
Expand All @@ -442,7 +441,7 @@ define('ci-name', {
description: `
The name of a continuous integration system. If not set explicitly, npm
will detect the current CI environment using the
[\`@npmcli/ci-detect\`](http://npm.im/@npmcli/ci-detect) module.
[\`ci-info\`](http://npm.im/@npmcli/ci-info) module.
`,
flatten,
})
Expand Down Expand Up @@ -1597,7 +1596,7 @@ define('production', {
})

define('progress', {
default: !ciName,
default: !ciInfo.isCI,
defaultDescription: `
\`true\` unless running in a known CI system
`,
Expand Down
4 changes: 2 additions & 2 deletions lib/utils/update-notifier.js
Expand Up @@ -3,7 +3,7 @@
// Check daily for betas, and weekly otherwise.

const pacote = require('pacote')
const ciDetect = require('@npmcli/ci-detect')
const ciInfo = require('ci-info')
const semver = require('semver')
const chalk = require('chalk')
const { promisify } = require('util')
Expand Down Expand Up @@ -39,7 +39,7 @@ const updateNotifier = async (npm, spec = 'latest') => {
// never check for updates in CI, when updating npm already, or opted out
if (!npm.config.get('update-notifier') ||
isGlobalNpmUpdate(npm) ||
ciDetect()) {
ciInfo.isCI) {
return SKIP
}

Expand Down
2 changes: 1 addition & 1 deletion node_modules/.gitignore
Expand Up @@ -15,7 +15,6 @@
!/@npmcli/
/@npmcli/*
!/@npmcli/arborist
!/@npmcli/ci-detect
!/@npmcli/config
!/@npmcli/disparity-colors
!/@npmcli/fs
Expand Down Expand Up @@ -55,6 +54,7 @@
!/cacache
!/chalk
!/chownr
!/ci-info
!/cidr-regex
!/clean-stack
!/cli-columns
Expand Down
15 changes: 0 additions & 15 deletions node_modules/@npmcli/ci-detect/LICENSE

This file was deleted.

52 changes: 0 additions & 52 deletions node_modules/@npmcli/ci-detect/lib/index.js

This file was deleted.

44 changes: 0 additions & 44 deletions node_modules/@npmcli/ci-detect/package.json

This file was deleted.

21 changes: 21 additions & 0 deletions node_modules/ci-info/LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016-2021 Thomas Watson Steen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
70 changes: 70 additions & 0 deletions node_modules/ci-info/index.d.ts
@@ -0,0 +1,70 @@
/**
* 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`.
*/
export const isCI: 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`.
*/
export const isPR: boolean | null;
/**
* 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.
*/
export const name: string | null;

export const APPVEYOR: boolean;
export const AZURE_PIPELINES: boolean;
export const APPCIRCLE: boolean;
export const BAMBOO: boolean;
export const BITBUCKET: boolean;
export const BITRISE: boolean;
export const BUDDY: boolean;
export const BUILDKITE: boolean;
export const CIRCLE: boolean;
export const CIRRUS: boolean;
export const CODEBUILD: boolean;
export const CODEMAGIC: boolean;
export const CODEFRESH: boolean;
export const CODESHIP: boolean;
export const DRONE: boolean;
export const DSARI: boolean;
export const EAS: boolean;
export const GERRIT: boolean;
export const GITHUB_ACTIONS: boolean;
export const GITLAB: boolean;
export const GOCD: boolean;
export const GOOGLE_CLOUD_BUILD: boolean;
export const HEROKU: boolean;
export const HUDSON: boolean;
export const JENKINS: boolean;
export const LAYERCI: boolean;
export const MAGNUM: boolean;
export const NETLIFY: boolean;
export const NEVERCODE: boolean;
export const RENDER: boolean;
export const SAIL: boolean;
export const SEMAPHORE: boolean;
export const SCREWDRIVER: boolean;
export const SHIPPABLE: boolean;
export const SOLANO: boolean;
export const STRIDER: boolean;
export const TASKCLUSTER: boolean;
export const TEAMCITY: boolean;
export const TRAVIS: boolean;
export const VERCEL: boolean;
export const APPCENTER: boolean;
export const XCODE_CLOUD: boolean;
export const XCODE_SERVER: boolean;
export const WOODPECKER: boolean;

0 comments on commit a351685

Please sign in to comment.