Add --release option info to meteor publish #12956
Conversation
…tation for the --release option in the meteor publish command. The --release option is introduced to help resolve top-level version conflicts during the package publishing process, especially in scenarios where packages have conflicting version requirements. Users can now specify the appropriate release version to satisfy all package version constraints. Fixes meteor#12954
|
|
|
@jankapunkt please check |
| @@ -914,11 +914,11 @@ Options: | |||
| Publish a new version of a package to the package server. | |||
|
|
|||
| Usage: meteor publish [--create] | |||
| meteor publish --update | |||
| meteor publish --update [--release <version>] | |||
There was a problem hiding this comment.
I'm wondering if --release should be moved to the first example. It's normally used when publishing a new version instead of when updating the metadata.
There was a problem hiding this comment.
I agree, especially now, using --release might become more necessary
| --release <version> | ||
| resolve top-level version conflicts by specifying the release | ||
| version. This option is particularly useful during the migration | ||
| process when dealing with packages that have conflicting version | ||
| requirements. Specify the version that satisfies all package | ||
| version constraints. |
There was a problem hiding this comment.
This description is correct, but it describes one of the few side effects of using the --release option. The description should probably start with describing what the option does: --release Specify the release of Meteor to use (taken from the meteor run help).
|
There seem to be a few other commands that are also missing documentation for |
This commit adds documentation for the --release option in the meteor publish
command. The --release option is introduced to help resolve top-level version
conflicts during the package publishing process, especially in scenarios where
packages have conflicting version requirements. Users can now specify the
appropriate release version to satisfy all package version constraints.
Fixes #12954