//! Helper script to publish the wasmtime and cranelift suites of crates //! //! See documentation in `docs/contributing-release-process.md` for more //! information, but in a nutshell: //! //! * `./publish bump` - bump crate versions in-tree //! * `./publish verify` - verify crates can be published to crates.io //! * `./publish publish` - actually publish crates to crates.io use std::collections::HashMap; use std::env; use std::fs; use std::path::{Path, PathBuf}; use std::process::{Command, ExitStatus, Output, Stdio}; use std::thread; use std::time::Duration; // note that this list must be topologically sorted by dependencies const CRATES_TO_PUBLISH: &[&str] = &[ // cranelift "cranelift-isle", "cranelift-entity", "wasmtime-types", "cranelift-bforest", "cranelift-codegen-shared", "cranelift-codegen-meta", "cranelift-egraph", "cranelift-control", "cranelift-codegen", "cranelift-reader", "cranelift-serde", "cranelift-module", "cranelift-frontend", "cranelift-wasm", "cranelift-native", "cranelift-object", "cranelift-interpreter", "cranelift", "wasmtime-jit-icache-coherence", "cranelift-jit", // wiggle "wiggle-generate", "wiggle-macro", // winch "winch", // wasmtime "wasmtime-asm-macros", "wasmtime-versioned-export-macros", "wasmtime-slab", "wasmtime-component-util", "wasmtime-wit-bindgen", "wasmtime-component-macro", "wasmtime-jit-debug", "wasmtime-fiber", "wasmtime-environ", "wasmtime-wmemcheck", "wasmtime-cranelift", "wasmtime-cache", "winch-codegen", "wasmtime-winch", "wasmtime", // wasi-common/wiggle "wiggle", "wasi-common", // other misc wasmtime crates "wasmtime-wasi", "wasmtime-wasi-http", "wasmtime-wasi-nn", "wasmtime-wasi-threads", "wasmtime-wast", "wasmtime-c-api-macros", "wasmtime-c-api-impl", "wasmtime-cli-flags", "wasmtime-explorer", "wasmtime-cli", ]; // Anything **not** mentioned in this array is required to have an `=a.b.c` // dependency requirement on it to enable breaking api changes even in "patch" // releases since everything not mentioned here is just an organizational detail // that no one else should rely on. const PUBLIC_CRATES: &[&str] = &[ // these are actually public crates which we cannot break the API of in // patch releases. "wasmtime", "wasmtime-wasi", "wasmtime-wasi-nn", "wasmtime-wasi-threads", "wasmtime-cli", // all cranelift crates are considered "public" in that they can't // have breaking API changes in patch releases "cranelift-entity", "cranelift-bforest", "cranelift-codegen-shared", "cranelift-codegen-meta", "cranelift-egraph", "cranelift-control", "cranelift-codegen", "cranelift-reader", "cranelift-serde", "cranelift-module", "cranelift-frontend", "cranelift-wasm", "cranelift-native", "cranelift-object", "cranelift-interpreter", "cranelift", "cranelift-jit", // This is a dependency of cranelift crates and as a result can't break in // patch releases as well "wasmtime-types", ]; const C_HEADER_PATH: &str = "./crates/c-api/include/wasmtime.h"; struct Workspace { version: String, } struct Crate { manifest: PathBuf, name: String, version: String, publish: bool, } fn main() { let mut crates = Vec::new(); let root = read_crate(None, "./Cargo.toml".as_ref()); let ws = Workspace { version: root.version.clone(), }; crates.push(root); find_crates("crates".as_ref(), &ws, &mut crates); find_crates("cranelift".as_ref(), &ws, &mut crates); find_crates("winch".as_ref(), &ws, &mut crates); let pos = CRATES_TO_PUBLISH .iter() .enumerate() .map(|(i, c)| (*c, i)) .collect::>(); crates.sort_by_key(|krate| pos.get(&krate.name[..])); match &env::args().nth(1).expect("must have one argument")[..] { name @ "bump" | name @ "bump-patch" => { for krate in crates.iter() { bump_version(&krate, &crates, name == "bump-patch"); } // update C API version in wasmtime.h update_capi_version(); // update the lock file run_cmd(Command::new("cargo").arg("fetch")); } "publish" => { // We have so many crates to publish we're frequently either // rate-limited or we run into issues where crates can't publish // successfully because they're waiting on the index entries of // previously-published crates to propagate. This means we try to // publish in a loop and we remove crates once they're successfully // published. Failed-to-publish crates get enqueued for another try // later on. for _ in 0..10 { crates.retain(|krate| !publish(krate)); if crates.is_empty() { break; } println!( "{} crates failed to publish, waiting for a bit to retry", crates.len(), ); thread::sleep(Duration::from_secs(40)); } assert!(crates.is_empty(), "failed to publish all crates"); println!(""); println!("==================================================================="); println!(""); println!("Don't forget to push a git tag for this release!"); println!(""); println!(" $ git tag vX.Y.Z"); println!(" $ git push git@github.com:bytecodealliance/wasmtime.git vX.Y.Z"); } "verify" => { verify(&crates); } s => panic!("unknown command: {}", s), } } fn cmd_output(cmd: &mut Command) -> Output { eprintln!("Running: `{:?}`", cmd); match cmd.output() { Ok(o) => o, Err(e) => panic!("Failed to run `{:?}`: {}", cmd, e), } } fn cmd_status(cmd: &mut Command) -> ExitStatus { eprintln!("Running: `{:?}`", cmd); match cmd.status() { Ok(s) => s, Err(e) => panic!("Failed to run `{:?}`: {}", cmd, e), } } fn run_cmd(cmd: &mut Command) { let status = cmd_status(cmd); assert!( status.success(), "Command `{:?}` exited with failure status: {}", cmd, status ); } fn find_crates(dir: &Path, ws: &Workspace, dst: &mut Vec) { if dir.join("Cargo.toml").exists() { let krate = read_crate(Some(ws), &dir.join("Cargo.toml")); if !krate.publish || CRATES_TO_PUBLISH.iter().any(|c| krate.name == *c) { dst.push(krate); } else { panic!("failed to find {:?} in whitelist or blacklist", krate.name); } } for entry in dir.read_dir().unwrap() { let entry = entry.unwrap(); if entry.file_type().unwrap().is_dir() { find_crates(&entry.path(), ws, dst); } } } fn read_crate(ws: Option<&Workspace>, manifest: &Path) -> Crate { let mut name = None; let mut version = None; let mut publish = true; for line in fs::read_to_string(manifest).unwrap().lines() { if name.is_none() && line.starts_with("name = \"") { name = Some( line.replace("name = \"", "") .replace("\"", "") .trim() .to_string(), ); } if version.is_none() && line.starts_with("version = \"") { version = Some( line.replace("version = \"", "") .replace("\"", "") .trim() .to_string(), ); } if let Some(ws) = ws { if version.is_none() && line.starts_with("version.workspace = true") { version = Some(ws.version.clone()); } } if line.starts_with("publish = false") { publish = false; } } let name = name.unwrap(); let version = version.unwrap(); Crate { manifest: manifest.to_path_buf(), name, version, publish, } } fn bump_version(krate: &Crate, crates: &[Crate], patch: bool) { let contents = fs::read_to_string(&krate.manifest).unwrap(); let next_version = |krate: &Crate| -> String { if CRATES_TO_PUBLISH.contains(&&krate.name[..]) { bump(&krate.version, patch) } else { krate.version.clone() } }; let mut new_manifest = String::new(); let mut is_deps = false; for line in contents.lines() { let mut rewritten = false; if !is_deps && line.starts_with("version =") { if CRATES_TO_PUBLISH.contains(&&krate.name[..]) { println!( "bump `{}` {} => {}", krate.name, krate.version, next_version(krate), ); new_manifest.push_str(&line.replace(&krate.version, &next_version(krate))); rewritten = true; } } is_deps = if line.starts_with("[") { line.contains("dependencies") } else { is_deps }; for other in crates { // If `other` isn't a published crate then it's not going to get a // bumped version so we don't need to update anything in the // manifest. if !other.publish { continue; } if !is_deps || !line.starts_with(&format!("{} ", other.name)) { continue; } if !line.contains(&other.version) { if !line.contains("version =") || !krate.publish { continue; } panic!( "{:?} has a dep on {} but doesn't list version {}", krate.manifest, other.name, other.version ); } if krate.publish { if PUBLIC_CRATES.contains(&other.name.as_str()) { assert!( !line.contains("\"="), "{} should not have an exact version requirement on {}", krate.name, other.name ); } else { assert!( line.contains("\"="), "{} should have an exact version requirement on {}", krate.name, other.name ); } } rewritten = true; new_manifest.push_str(&line.replace(&other.version, &next_version(other))); break; } if !rewritten { new_manifest.push_str(line); } new_manifest.push_str("\n"); } fs::write(&krate.manifest, new_manifest).unwrap(); } fn update_capi_version() { let version = read_crate(None, "./Cargo.toml".as_ref()).version; let mut iter = version.split('.').map(|s| s.parse::().unwrap()); let major = iter.next().expect("major version"); let minor = iter.next().expect("minor version"); let patch = iter.next().expect("patch version"); let mut new_header = String::new(); let contents = fs::read_to_string(C_HEADER_PATH).unwrap(); for line in contents.lines() { if line.starts_with("#define WASMTIME_VERSION \"") { new_header.push_str(&format!("#define WASMTIME_VERSION \"{version}\"")); } else if line.starts_with("#define WASMTIME_VERSION_MAJOR") { new_header.push_str(&format!("#define WASMTIME_VERSION_MAJOR {major}")); } else if line.starts_with("#define WASMTIME_VERSION_MINOR") { new_header.push_str(&format!("#define WASMTIME_VERSION_MINOR {minor}")); } else if line.starts_with("#define WASMTIME_VERSION_PATCH") { new_header.push_str(&format!("#define WASMTIME_VERSION_PATCH {patch}")); } else { new_header.push_str(line); } new_header.push_str("\n"); } fs::write(&C_HEADER_PATH, new_header).unwrap(); } /// Performs a major version bump increment on the semver version `version`. /// /// This function will perform a semver-major-version bump on the `version` /// specified. This is used to calculate the next version of a crate in this /// repository since we're currently making major version bumps for all our /// releases. This may end up getting tweaked as we stabilize crates and start /// doing more minor/patch releases, but for now this should do the trick. fn bump(version: &str, patch_bump: bool) -> String { let mut iter = version.split('.').map(|s| s.parse::().unwrap()); let major = iter.next().expect("major version"); let minor = iter.next().expect("minor version"); let patch = iter.next().expect("patch version"); if patch_bump { return format!("{}.{}.{}", major, minor, patch + 1); } if major != 0 { format!("{}.0.0", major + 1) } else if minor != 0 { format!("0.{}.0", minor + 1) } else { format!("0.0.{}", patch + 1) } } fn publish(krate: &Crate) -> bool { if !CRATES_TO_PUBLISH.iter().any(|s| *s == krate.name) { return true; } // First make sure the crate isn't already published at this version. This // script may be re-run and there's no need to re-attempt previous work. let output = cmd_output( Command::new("curl").arg(&format!("https://crates.io/api/v1/crates/{}", krate.name)), ); if output.status.success() && String::from_utf8_lossy(&output.stdout) .contains(&format!("\"newest_version\":\"{}\"", krate.version)) { println!( "skip publish {} because {} is latest version", krate.name, krate.version, ); return true; } let status = cmd_status( Command::new("cargo") .arg("publish") .current_dir(krate.manifest.parent().unwrap()) .arg("--no-verify"), ); if !status.success() { println!("FAIL: failed to publish `{}`: {}", krate.name, status); return false; } // After we've published then make sure that the `wasmtime-publish` group is // added to this crate for future publications. If it's already present // though we can skip the `cargo owner` modification. let output = cmd_output(Command::new("curl").arg(&format!( "https://crates.io/api/v1/crates/{}/owners", krate.name ))); if output.status.success() && String::from_utf8_lossy(&output.stdout).contains("wasmtime-publish") { println!( "wasmtime-publish already listed as an owner of {}", krate.name ); return true; } // Note that the status is ignored here. This fails most of the time because // the owner is already set and present, so we only want to add this to // crates which haven't previously been published. run_cmd( Command::new("cargo") .arg("owner") .arg("-a") .arg("github:bytecodealliance:wasmtime-publish") .arg(&krate.name), ); true } // Verify the current tree is publish-able to crates.io. The intention here is // that we'll run `cargo package` on everything which verifies the build as-if // it were published to crates.io. This requires using an incrementally-built // directory registry generated from `cargo vendor` because the versions // referenced from `Cargo.toml` may not exist on crates.io. fn verify(crates: &[Crate]) { verify_capi(); drop(fs::remove_dir_all(".cargo")); drop(fs::remove_dir_all("vendor")); let vendor = cmd_output(Command::new("cargo").arg("vendor").stderr(Stdio::inherit())); assert!(vendor.status.success()); fs::create_dir_all(".cargo").unwrap(); fs::write(".cargo/config.toml", vendor.stdout).unwrap(); for krate in crates { if !krate.publish { continue; } verify_and_vendor(&krate); } fn verify_and_vendor(krate: &Crate) { let mut cmd = Command::new("cargo"); cmd.arg("package") .arg("--manifest-path") .arg(&krate.manifest) .env("CARGO_TARGET_DIR", "./target"); if krate.name.contains("wasi-nn") { cmd.arg("--no-verify"); } run_cmd(&mut cmd); run_cmd( Command::new("tar") .arg("xf") .arg(format!( "../target/package/{}-{}.crate", krate.name, krate.version )) .current_dir("./vendor"), ); fs::write( format!( "./vendor/{}-{}/.cargo-checksum.json", krate.name, krate.version ), "{\"files\":{}}", ) .unwrap(); } fn verify_capi() { let version = read_crate(None, "./Cargo.toml".as_ref()).version; let mut iter = version.split('.').map(|s| s.parse::().unwrap()); let major = iter.next().expect("major version"); let minor = iter.next().expect("minor version"); let patch = iter.next().expect("patch version"); let mut count = 0; let contents = fs::read_to_string(C_HEADER_PATH).unwrap(); for line in contents.lines() { if line.starts_with(&format!("#define WASMTIME_VERSION \"{version}\"")) { count += 1; } else if line.starts_with(&format!("#define WASMTIME_VERSION_MAJOR {major}")) { count += 1; } else if line.starts_with(&format!("#define WASMTIME_VERSION_MINOR {minor}")) { count += 1; } else if line.starts_with(&format!("#define WASMTIME_VERSION_PATCH {patch}")) { count += 1; } } assert!( count == 4, "invalid version macros in {}, should match \"{}\"", C_HEADER_PATH, version ); } }