Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add --release option info to meteor publish #12956

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Add --release option info to meteor publish #12956

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a4610e
Add --release option info to meteor publish This commit adds documen…
qwertyroop Jan 11, 2024
f2b1867
Merge branch 'devel' into devel
StorytellerCZ Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 8 additions & 2 deletions tools/cli/help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, especially now, using --release might become more necessary


Publishes a new version of a local package to the package server. Must be run
from the directory containing the package. Reads the package.js file for version
information, builds the package and sends both the package source and the built
information, builds the package, and sends both the package source and the built
version of the package to the package server.

This will create at most one build of the package. If the package has an
Expand All @@ -941,6 +941,12 @@ Pass --create to create a new package.
Options:
--create publish a new package
--update changed metadata of a previously published version
--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.
Comment on lines +944 to +949
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

--allow-incompatible-update Allow packages in your project to be upgraded or
downgraded to versions that are potentially incompatible with the
current versions, if required to satisfy all package version
Expand Down