fix: deprecate ci-name config (#6434)

npm · May 16, 2023 · 23c865f · 23c865f
1 parent 7ade93d
commit 23c865f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 10 deletions.
diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -439,6 +439,9 @@ define('ci-name', {
     platform.
   `,
   type: [null, String],
+  deprecated: `
+    This config is deprecated and will not be changeable in future version of npm.
+  `,
   description: `
     The name of a continuous integration system.  If not set explicitly, npm
     will detect the current CI environment using the

diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
@@ -332,16 +332,6 @@ npm exec --package yo --package generator-node --call "yo node"
 \`\`\`
 
 
-#### \`ci-name\`
-
-* Default: The name of the current CI system, or \`null\` when not on a known CI
-  platform.
-* Type: null or String
-
-The name of a continuous integration system. If not set explicitly, npm will
-detect the current CI environment using the
-[\`ci-info\`](http://npm.im/ci-info) module.
-
 #### \`cidr\`
 
 * Default: null
@@ -1557,6 +1547,18 @@ It is _not_ the path to a certificate file, though you can set a
 registry-scoped "certfile" path like
 "//other-registry.tld/:certfile=/path/to/cert.pem".
 
+#### \`ci-name\`
+
+* Default: The name of the current CI system, or \`null\` when not on a known CI
+  platform.
+* Type: null or String
+* DEPRECATED: This config is deprecated and will not be changeable in future
+  version of npm.
+
+The name of a continuous integration system. If not set explicitly, npm will
+detect the current CI environment using the
+[\`ci-info\`](http://npm.im/ci-info) module.
+
 #### \`dev\`
 
 * Default: false