Skip to content

Commit 1108ebf

Browse files
JamesHenryJamesHenry
authored
fix(release): support forwarding the --access flag to npm publish (#27765)
1 parent 10b9051 commit 1108ebf

File tree

8 files changed

+121
-8
lines changed

8 files changed

+121
-8
lines changed

‎docs/generated/cli/release.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ nx release publish
112112

113113
| Option | Type | Description |
114114
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115+
| `--access` | `public`, `restricted` | Overrides the access level of the published package. Unscoped packages cannot be set to restricted. See the npm publish documentation for more information. |
115116
| `--all` | boolean | [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required. (Default: `true`) |
116117
| `--exclude` | string | Exclude certain projects from being processed |
117118
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first (Default: `false`) |
@@ -130,3 +131,48 @@ nx release publish
130131
| `--tag` | string | The distribution tag to apply to the published package |
131132
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces) |
132133
| `--version` | boolean | Show version number |
134+
135+
### plan
136+
137+
Create a version plan file to specify the desired semver bump for one or more projects or groups, as well as the relevant changelog entry
138+
139+
```shell
140+
nx release plan [bump]
141+
```
142+
143+
## Options
144+
145+
| Option | Type | Description |
146+
| --------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
147+
| `--base` | string | Base of the current branch (usually main) |
148+
| `--bump` | `major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, `prerelease` | Semver keyword to use for the selected release group. |
149+
| `--exclude` | string | Exclude certain projects from being processed |
150+
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces |
151+
| `--head` | string | Latest commit of the current branch (usually HEAD) |
152+
| `--help` | boolean | Show help |
153+
| `--message` | string | Custom message to use for the changelog entry |
154+
| `--onlyTouched` | boolean | Only include projects that have been affected by the current changes (Default: `true`) |
155+
| `--uncommitted` | boolean | Uncommitted changes |
156+
| `--untracked` | boolean | Untracked changes |
157+
| `--version` | boolean | Show version number |
158+
159+
### plan:check
160+
161+
Ensure that all touched projects have an applicable version plan created for them
162+
163+
```shell
164+
nx release plan:check
165+
```
166+
167+
## Options
168+
169+
| Option | Type | Description |
170+
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
171+
| `--base` | string | Base of the current branch (usually main) |
172+
| `--exclude` | string | Exclude certain projects from being processed |
173+
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces |
174+
| `--head` | string | Latest commit of the current branch (usually HEAD) |
175+
| `--help` | boolean | Show help |
176+
| `--uncommitted` | boolean | Uncommitted changes |
177+
| `--untracked` | boolean | Untracked changes |
178+
| `--version` | boolean | Show version number |

‎docs/generated/packages/js/executors/release-publish.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020
"type": "string",
2121
"description": "The distribution tag to apply to the published package."
2222
},
23+
"access": {
24+
"type": "string",
25+
"enum": ["public", "restricted"],
26+
"description": "Overrides the access level of the published package. Unscoped packages cannot be set to restricted. See the npm publish documentation for more information."
27+
},
2328
"dryRun": {
2429
"type": "boolean",
2530
"description": "Whether to run the command without actually publishing the package to the registry."

0 commit comments

Comments
 (0)