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.

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

Document --release option on meteor publish command #12954

Open
jankapunkt opened this issue Jan 8, 2024 · 0 comments · May be fixed by #12956
Open

Document --release option on meteor publish command #12954

jankapunkt opened this issue Jan 8, 2024 · 0 comments · May be fixed by #12956
Labels
confirmed We want to fix or implement it good first issue Good first issue or something that should is nice to do. missing-docs Documentation or history entry is missing for the PR

Comments

@jankapunkt
Copy link
Contributor

Using Meteor 2.14 I can enter meteor publish --help which gives the following documentation:

Usage: meteor publish [--create]
       meteor publish --update

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
version of the package to the package server.

This will create at most one build of the package. If the package has an
OS-dependent binary component, publishing will only register metadata about the
package. The binary component will be compiled when it is installed into an
application with `meteor add`. To pre-build a package for a particular platform,
use the `meteor publish-for-arch` command.

This will mark you as the only maintainer of the package. You can use
'meteor admin maintainers' to change package maintainers. For more information
about admin commands, run 'meteor help admin'.

Change the metadata for a given version of a package by running with the
--update flag. That will set the git url, version summary, longform description
and documentation in the database to their new values. You can use 'meteor show'
to preview the results.

Pass --create to create a new package.

Options:
  --create   publish a new package
  --update   changed metadata of a previously published version
  --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
             constraints.
  --no-lint  don't run linters on the published package and its local
             dependencies before publishing

However, I didn't know that I can actually use --release here in order to resolve "top-level" version conflicts, which was recently a big blocker when attempting to publish packages for 3.0 beta.

This option should be added to the help and maybe also to the migration docs. Might be crucial for people who struggle with migrating packages.

@Grubba27 Grubba27 added confirmed We want to fix or implement it good first issue Good first issue or something that should is nice to do. missing-docs Documentation or history entry is missing for the PR labels Jan 9, 2024
qwertyroop added a commit to qwertyroop/meteor that referenced this issue Jan 11, 2024
…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
@qwertyroop qwertyroop linked a pull request Jan 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed We want to fix or implement it good first issue Good first issue or something that should is nice to do. missing-docs Documentation or history entry is missing for the PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants