Skip to content

feat: skip publish=false pkg when publishing entire workspace #15525

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

Merged
merged 4 commits into from
May 14, 2025
Merged

feat: skip publish=false pkg when publishing entire workspace #15525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2421496
test(publish): prepare tests for skipping unpublishable
weihanglo May 14, 2025
6f81364
refactor(publish): extract "no publishable found" error
weihanglo May 14, 2025
4f7494c
feat(publish): workspace publish skips `publish=false`
weihanglo May 14, 2025
090dcfe
fix(publish): better message when nothing to publish
weihanglo May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 40 additions & 13 deletions src/cargo/ops/registry/publish.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,46 @@ pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
.filter(|(m, _)| specs.iter().any(|spec| spec.matches(m.package_id())))
.collect();

let (unpublishable, pkgs): (Vec<_>, Vec<_>) = pkgs
.into_iter()
.partition(|(pkg, _)| pkg.publish() == &Some(vec![]));
// If `--workspace` is passed,
// the intent is more like "publish all publisable packages in this workspace",
// so skip `publish=false` packages.
let allow_unpublishable = multi_package_mode
&& match &opts.to_publish {
Packages::Default => ws.is_virtual(),
Packages::All(_) => true,
Packages::OptOut(_) => true,
Packages::Packages(_) => false,
};
if !unpublishable.is_empty() && !allow_unpublishable {
bail!(
"{} cannot be published.\n\
`package.publish` must be set to `true` or a non-empty list in Cargo.toml to publish.",
unpublishable
.iter()
.map(|(pkg, _)| format!("`{}`", pkg.name()))
.join(", "),
);
}

if pkgs.is_empty() {
if allow_unpublishable {
let n = unpublishable.len();
let plural = if n == 1 { "" } else { "s" };
ws.gctx().shell().warn(format_args!(
"nothing to publish, but found {n} unpublishable package{plural}"
))?;
ws.gctx().shell().note(format_args!(
"to publish packages, set `package.publish` to `true` or a non-empty list"
))?;
return Ok(());
} else {
unreachable!("must have at least one publishable package");
}
}

let just_pkgs: Vec<_> = pkgs.iter().map(|p| p.0).collect();
let reg_or_index = match opts.reg_or_index.clone() {
Some(r) => {
Expand Down Expand Up @@ -705,19 +745,6 @@ fn package_list(pkgs: impl IntoIterator<Item = PackageId>, final_sep: &str) -> S
}

fn validate_registry(pkgs: &[&Package], reg_or_index: Option<&RegistryOrIndex>) -> CargoResult<()> {
let unpublishable = pkgs
Copy link
Contributor

Choose a reason for hiding this comment

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

Small nit, feel free to pass on. I'm mentioning this only since I had other comments.

Would make reviewing easier if ĵust moving this error check was a separate refactor commit.

.iter()
.filter(|pkg| pkg.publish() == &Some(Vec::new()))
.map(|pkg| format!("`{}`", pkg.name()))
.collect::<Vec<_>>();
if !unpublishable.is_empty() {
bail!(
"{} cannot be published.\n\
`package.publish` must be set to `true` or a non-empty list in Cargo.toml to publish.",
unpublishable.join(", ")
);
}

let reg_name = match reg_or_index {
Some(RegistryOrIndex::Registry(r)) => Some(r.as_str()),
None => Some(CRATES_IO_REGISTRY),
Expand Down
Loading