Skip to content

Commit 23c865f

Browse files
authored
fix: deprecate ci-name config (#6434)
1 parent 7ade93d commit 23c865f

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

lib/utils/config/definitions.js

+3
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,9 @@ define('ci-name', {
439439
platform.
440440
`,
441441
type: [null, String],
442+
deprecated: `
443+
This config is deprecated and will not be changeable in future version of npm.
444+
`,
442445
description: `
443446
The name of a continuous integration system. If not set explicitly, npm
444447
will detect the current CI environment using the

tap-snapshots/test/lib/docs.js.test.cjs

+12-10
Original file line numberDiff line numberDiff line change
@@ -332,16 +332,6 @@ npm exec --package yo --package generator-node --call "yo node"
332332
\`\`\`
333333
334334
335-
#### \`ci-name\`
336-
337-
* Default: The name of the current CI system, or \`null\` when not on a known CI
338-
platform.
339-
* Type: null or String
340-
341-
The name of a continuous integration system. If not set explicitly, npm will
342-
detect the current CI environment using the
343-
[\`ci-info\`](http://npm.im/ci-info) module.
344-
345335
#### \`cidr\`
346336
347337
* Default: null
@@ -1557,6 +1547,18 @@ It is _not_ the path to a certificate file, though you can set a
15571547
registry-scoped "certfile" path like
15581548
"//other-registry.tld/:certfile=/path/to/cert.pem".
15591549
1550+
#### \`ci-name\`
1551+
1552+
* Default: The name of the current CI system, or \`null\` when not on a known CI
1553+
platform.
1554+
* Type: null or String
1555+
* DEPRECATED: This config is deprecated and will not be changeable in future
1556+
version of npm.
1557+
1558+
The name of a continuous integration system. If not set explicitly, npm will
1559+
detect the current CI environment using the
1560+
[\`ci-info\`](http://npm.im/ci-info) module.
1561+
15601562
#### \`dev\`
15611563
15621564
* Default: false

0 commit comments

Comments
 (0)