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

xtask: allow public-api regen on aarch64-apple-darwin #853

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Changes from all commits
Commits
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
76 changes: 56 additions & 20 deletions xtask/src/public_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::{
};

use anyhow::{bail, Context as _, Result};
use cargo_metadata::{Metadata, Package};
use cargo_metadata::{Metadata, Package, Target};
use clap::Parser;
use dialoguer::{theme::ColorfulTheme, Confirm};
use diff::{lines, Result as Diff};
Expand All @@ -17,11 +17,15 @@ pub struct Options {
/// Bless new API changes.
#[clap(long)]
pub bless: bool,

/// Bless new API changes.
#[clap(long)]
pub target: Option<String>,
}

pub fn public_api(options: Options, metadata: Metadata) -> Result<()> {
let toolchain = "nightly";
let Options { bless } = options;
let Options { bless, target } = options;

if !rustup_toolchain::is_installed(toolchain)? {
if Confirm::with_theme(&ColorfulTheme::default())
Expand All @@ -42,21 +46,40 @@ pub fn public_api(options: Options, metadata: Metadata) -> Result<()> {

let errors: Vec<_> = packages
.into_iter()
.map(|Package { name, publish, .. }| {
if matches!(publish, Some(publish) if publish.is_empty()) {
Ok(())
} else {
let diff = check_package_api(&name, toolchain, bless, workspace_root.as_std_path())
.with_context(|| format!("{name} failed to check public API"))?;
if diff.is_empty() {
.map(
|Package {
name,
publish,
targets,
..
}| {
if matches!(publish, Some(publish) if publish.is_empty()) {
Ok(())
} else {
Err(anyhow::anyhow!(
"{name} public API changed; re-run with --bless. diff:\n{diff}"
))
let target = target.as_ref().and_then(|target| {
let proc_macro = targets.iter().any(|Target { kind, .. }| {
kind.iter().any(|kind| kind == "proc-macro")
});
(!proc_macro).then_some(target)
});
let diff = check_package_api(
&name,
toolchain,
target.cloned(),
bless,
workspace_root.as_std_path(),
)
.with_context(|| format!("{name} failed to check public API"))?;
if diff.is_empty() {
Ok(())
} else {
Err(anyhow::anyhow!(
"{name} public API changed; re-run with --bless. diff:\n{diff}"
))
}
}
}
})
},
)
.filter_map(|result| match result {
Ok(()) => None,
Err(err) => Some(err),
Expand All @@ -73,6 +96,7 @@ pub fn public_api(options: Options, metadata: Metadata) -> Result<()> {
fn check_package_api(
package: &str,
toolchain: &str,
target: Option<String>,
bless: bool,
workspace_root: &Path,
) -> Result<String> {
Expand All @@ -82,16 +106,28 @@ fn check_package_api(
.join(package)
.with_extension("txt");

let rustdoc_json = rustdoc_json::Builder::default()
let mut builder = rustdoc_json::Builder::default()
.toolchain(toolchain)
.package(package)
.all_features(true)
.build()
.context("rustdoc_json::Builder::build")?;
.all_features(true);
if let Some(target) = target {
builder = builder.target(target);
}
let rustdoc_json = builder.build().with_context(|| {
format!(
"rustdoc_json::Builder::default().toolchain({}).package({}).build()",
toolchain, package
)
})?;

let public_api = public_api::Builder::from_rustdoc_json(rustdoc_json)
let public_api = public_api::Builder::from_rustdoc_json(&rustdoc_json)
.build()
.context("public_api::Builder::build")?;
.with_context(|| {
format!(
"public_api::Builder::from_rustdoc_json({})::build()",
rustdoc_json.display()
)
})?;

if bless {
let mut output =
Expand Down