CLI documentation update from CI
CI User committed
Apr 16, 2021 at 02:32 UTC
d0bcc3c9e96c73fe7fc7ff1e47970d774084a9f4
3 files changed
+54
-37
cli/v7
+1
-1
@@ -1 +1 @@
1
-Subproject commit 13843f489401d918e7f1a41ed1ff636fc3feb603
1
+Subproject commit a4e7f4e4b40d645fed97622a97c7fa72aa5da82b
content/cli/v7/commands/npm-bugs.md
+3
-3
@@ -25,9 +25,9 @@ aliases: issues
25
### Description
26
27
This command tries to guess at the likely location of a package's bug
28
-tracker URL, and then tries to open it using the `--browser` config param.
29
-If no package name is provided, it will search for a `package.json` in the
30
-current folder and use the `name` property.
28
+tracker URL or the `mailto` URL of the support email, and then tries to
29
+open it using the `--browser` config param. If no package name is provided, it
30
+will search for a `package.json` in the current folder and use the `name` property.
31
32
### Configuration
33
content/cli/v7/commands/npm-version.md
+50
-33
@@ -24,6 +24,56 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat
24
'npm ls' to inspect current package/dependency versions
25
```
26
27
+### Configuration
28
+
29
+#### `allow-same-version`
30
+
31
+* Default: `false`
32
+* Type: Boolean
33
+
34
+Prevents throwing an error when `npm version` is used to set the new version
35
+to the same value as the current version.
36
+
37
+#### `git-tag-version`
38
+
39
+* Default: `true`
40
+* Type: Boolean
41
+
42
+Commit and tag the version change.
43
+
44
+#### `commit-hooks`
45
+
46
+* Default: `true`
47
+* Type: Boolean
48
+
49
+Run git commit hooks when committing the version change.
50
+
51
+#### `sign-git-tag`
52
+
53
+* Default: `false`
54
+* Type: Boolean
55
+
56
+Pass the `-s` flag to git to sign the tag.
57
+
58
+Note that you must have a default GPG key set up in your git config for this to work properly.
59
+
60
+#### workspaces
61
+
62
+* Default: `false`
63
+* Type: Boolean
64
+
65
+Enables workspaces context and includes workspaces in reported output
66
+when getting versions. When setting a new version *only the workspaces
67
+will be changed*.
68
+
69
+#### workspace
70
+
71
+* Default: []
72
+* Type: Array
73
+
74
+Enables workspaces context and limits results to only those specified by
75
+this config item.
76
+
77
### Description
78
79
Run this in a package directory to bump the version and write the new
@@ -97,39 +147,6 @@ This runs all your tests and proceeds only if they pass. Then runs your `build`
147
adds everything in the `dist` directory to the commit. After the commit, it pushes the new commit
148
and tag up to the server, and deletes the `build/temp` directory.
149
100
-### Configuration
101
-
102
-#### `allow-same-version`
103
-
104
-* Default: `false`
105
-* Type: Boolean
106
-
107
-Prevents throwing an error when `npm version` is used to set the new version
108
-to the same value as the current version.
109
-
110
-#### `git-tag-version`
111
-
112
-* Default: `true`
113
-* Type: Boolean
114
-
115
-Commit and tag the version change.
116
-
117
-#### `commit-hooks`
118
-
119
-* Default: `true`
120
-* Type: Boolean
121
-
122
-Run git commit hooks when committing the version change.
123
-
124
-#### `sign-git-tag`
125
-
126
-* Default: `false`
127
-* Type: Boolean
128
-
129
-Pass the `-s` flag to git to sign the tag.
130
-
131
-Note that you must have a default GPG key set up in your git config for this to work properly.
132
-
150
### See Also
151
152
* [npm init](/cli/v7/commands/npm-init)