You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-5Lines changed: 20 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -77,8 +77,10 @@ You can set any or all of the following input parameters:
77
77
|`token` |string |yes | |The NPM auth token to use for publishing
78
78
|`registry` |string |no |https://registry.npmjs.org/ |The NPM registry URL to use
79
79
|`package` |string |no |./package.json |The path of your package.json file
80
-
|`check-version` |boolean |no |true |Only publish to NPM if the version number in `package.json` differs from the latest on NPM
80
+
|`tag` |string |no |"latest" |The tag to publish to. This allows people to install the package using `npm install <package-name>@<tag>`.
81
+
|`access` |string |no |"public" for non-scoped packages. "restricted" for scoped packages.|Determines whether the published package should be publicly visible, or restricted to members of your NPM organization.
81
82
|`dry-run` |boolean |no |false |Run NPM publish with the `--dry-run` flag to prevent publication
83
+
|`check-version` |boolean |no |true |Only publish to NPM if the version number in `package.json` differs from the latest on NPM
82
84
83
85
84
86
@@ -104,6 +106,8 @@ steps:
104
106
|`type` |string |The type of version change that occurred ("major", "minor", "patch", etc.). If there was no version change, then type will be "none".
105
107
|`version` |string |The version that was published
106
108
|`old-version` |string |The version number that was previously published to NPM
109
+
|`tag` |string |The tag that the package was published to.
110
+
|`access` |string |Indicates whether the published package is publicly visible or restricted to members of your NPM organization.
107
111
|`dry-run` |boolean |Indicates whether NPM was run in "dry run" mode
108
112
109
113
@@ -139,8 +143,10 @@ As shown in the example above, you can pass options to the `npmPublish()` functi
139
143
|`token` |string |NPM's default credentials |The NPM auth token to use for publishing. If not set, then NPM will
140
144
|`registry` |string |https://registry.npmjs.org/ |The NPM registry URL to use
141
145
|`package` |string |./package.json |The path of your package.json file
142
-
|`checkVersion` |boolean |true |Only publish to NPM if the version number in `package.json` differs from the latest on NPM
146
+
|`tag` |string |"latest" |The tag to publish to. This allows people to install the package using `npm install <package-name>@<tag>`.
147
+
|`access` |string |"public" for non-scoped packages. "restricted" for scoped packages.|Determines whether the published package should be publicly visible, or restricted to members of your NPM organization.
143
148
|`dryRun` |boolean |false |Run NPM publish with the `--dry-run` flag to prevent publication
149
+
|`checkVersion` |boolean |true |Only publish to NPM if the version number in `package.json` differs from the latest on NPM
144
150
|`quiet` |boolean |false |Suppress console output from NPM and npm-publish
145
151
|`debug` |function |no-op |A function to log debug messages. You can set this to a custom function to receive debug messages, or just set it to `console.debug` to print debug messages to the console.
146
152
@@ -153,6 +159,8 @@ The `npmPublish()` function asynchronously returns an object with the following
153
159
|`package` |string |The name of the NPM package that was published
154
160
|`version` |string |The version number that was published
155
161
|`oldVersion` |string |The version number that was previously published to NPM
162
+
|`tag` |string |The tag that the package was published to.
163
+
|`access` |string |Indicates whether the published package is publicly visible or restricted to members of your NPM organization.
156
164
|`dryRun` |boolean |Indicates whether NPM was run in "dry run" mode
157
165
158
166
@@ -190,6 +198,16 @@ options:
190
198
191
199
--registry <url> The NPM registry URL to use
192
200
201
+
--tag <tag> The tag to publish to. Allows the package to be installed
202
+
using "npm install <package-name>@<tag>"
203
+
204
+
--access <access> "public" = The package will be publicly visible.
205
+
"restricted" = The package will only be visible to members
206
+
of your NPM organization.
207
+
208
+
--dry-run Don't actually publish to NPM, but report what would have
209
+
been published
210
+
193
211
--debug, -d Enable debug mode, with increased logging
194
212
195
213
--quiet, -q Suppress unnecessary output
@@ -198,9 +216,6 @@ options:
198
216
199
217
--help, -h Show help
200
218
201
-
--dry-run Don't actually publish to NPM, but report what would have
202
-
been published
203
-
204
219
package_path The absolute or relative path of the NPM package to publish.
205
220
Can be a directory path, or the path of a package.json file.
0 commit comments