Copy xtask version bumper from nrf-hal

Minor changes to accomodate the slightly different CHANGELOG format.

Author: robyoung

CHANGELOG.md

@@ -26,5 +26,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Fix rustdoc warnings
 - Upgrade nrf51-hal to 0.12.1
 
-[Unreleased]: https://github.com/therealprof/microbit/compare/v0.9.0...HEAD
-[0.9.0]: https://github.com/therealprof/microbit/compare/v0.8.0...v0.9.0
+[Unreleased]: https://github.com/nrf-rs/microbit/compare/v0.9.0...HEAD
+[0.9.0]: https://github.com/nrf-rs/microbit/compare/v0.8.0...v0.9.0

microbit-common/src/lib.rs

@@ -1,6 +1,7 @@
 //! microbit contains everything required to get started with the use of Rust
 //! to create firmwares for the fabulous [BBC micro:bit](https://microbit.org)
 //! microcontroller board.
+#![doc(html_root_url = "https://docs.rs/microbit-common/0.9.0")]
 #![no_std]
 #![deny(missing_docs)]
 #![allow(non_camel_case_types)]

microbit-v2/Cargo.toml

@@ -32,3 +32,4 @@ path = "src/lib.rs"
 [dependencies.microbit-common]
 path = "../microbit-common"
 features = ["v2"]
+version = "=0.9.0"

microbit-v2/src/lib.rs

@@ -8,6 +8,7 @@
 //!
 //! [<img src="https://github.com/microbit-foundation/microbit-svg/raw/master/microbit-drawing-back-1-5.png" width="372px" height="300px">](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-1-5.png)
 //! [<img src="https://github.com/microbit-foundation/microbit-svg/raw/master/microbit-drawing-back-2.png" width="372px" height="300px">](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-2.png)
+#![doc(html_root_url = "https://docs.rs/microbit-v2/0.9.0")]
 #![no_std]
 #![deny(missing_docs)]
 #![allow(non_camel_case_types)]

microbit/Cargo.toml

@@ -28,3 +28,4 @@ license = "0BSD"
 [dependencies.microbit-common]
 path = "../microbit-common"
 features = ["v1"]
+version = "=0.9.0"

microbit/src/lib.rs

@@ -8,6 +8,7 @@
 //!
 //! [<img src="https://github.com/microbit-foundation/microbit-svg/raw/master/microbit-drawing-back-1-5.png" width="372px" height="300px">](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-1-5.png)
 //! [<img src="https://github.com/microbit-foundation/microbit-svg/raw/master/microbit-drawing-back-2.png" width="372px" height="300px">](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-2.png)
+#![doc(html_root_url = "https://docs.rs/microbit/0.9.0")]
 #![no_std]
 #![deny(missing_docs)]
 #![allow(non_camel_case_types)]

xtask/src/bump.rs

@@ -0,0 +1,117 @@
+//! This has been copied pretty much wholesale from https://github.com/nrf-rs/nrf-hal/blob/master/xtask/src/lib.rs
+use super::CRATES;
+use std::fs;
+
+fn file_replace(path: &str, from: &str, to: &str, dry_run: bool) {
+    let old_contents = fs::read_to_string(path).unwrap();
+    let new_contents = old_contents.replacen(from, to, 1);
+    if old_contents == new_contents {
+        panic!("failed to replace `{}` -> `{}` in `{}`", from, to, path);
+    }
+
+    if !dry_run {
+        fs::write(path, new_contents).unwrap();
+    }
+}
+
+/// Bumps the versions of all crates and the changelog to `new_version`.
+///
+/// Dependency declarations are updated automatically. `html_root_url` is updated automatically.
+pub fn bump_versions(new_version: &str, dry_run: bool) {
+    let common_toml_path = "microbit-common/Cargo.toml";
+    let toml = fs::read_to_string(common_toml_path).unwrap();
+
+    let needle = "version = \"";
+    let version_pos = toml.find(needle).unwrap() + needle.len();
+    let version_rest = &toml[version_pos..];
+    let end_pos = version_rest.find('"').unwrap();
+    let old_version = &version_rest[..end_pos];
+
+    {
+        // Bump the changelog first, also check that it isn't empty.
+        let changelog_path = "CHANGELOG.md";
+        let changelog = fs::read_to_string(changelog_path).unwrap();
+        // (ignore empty changelog when this is a dry_run, since that runs in normal CI)
+        assert!(
+            dry_run || !changelog.contains("(no entries)"),
+            "changelog contains `(no entries)`; please fill it"
+        );
+
+        // Prepend empty "[Unreleased]" section, promote the current one.
+        let from = String::from("## [Unreleased]");
+        let to = format!("## [Unreleased]\n\n(no changes)\n\n## [{}]", new_version);
+        file_replace(changelog_path, &from, &to, dry_run);
+
+        // Replace the Unreleased link
+        let from = format!(
+            r#"[Unreleased]: https://github.com/nrf-rs/microbit/compare/v{old_version}...HEAD"#,
+            old_version = old_version,
+        );
+        let to = format!(
+            r#"[Unreleased]: https://github.com/nrf-rs/microbit/compare/v{new_version}...HEAD"#,
+            new_version = new_version,
+        );
+        file_replace(changelog_path, &from, &to, dry_run);
+
+        // Append release link at the end.
+        let mut changelog = fs::read_to_string(changelog_path).unwrap();
+        changelog.push_str(&format!(
+            "[{new_version}]: https://github.com/nrf-rs/microbit/releases/tag/v{new_version}...v{old_version}\n",
+            new_version = new_version,
+            old_version = old_version,
+        ));
+        if !dry_run {
+            fs::write(changelog_path, changelog).unwrap();
+        }
+    }
+
+    {
+        println!("microbit-common: {} -> {}", old_version, new_version);
+
+        // Bump `microbit-common`'s version.
+        let from = format!(r#"version = "{}""#, old_version);
+        let to = format!(r#"version = "{}""#, new_version);
+        file_replace("microbit-common/Cargo.toml", &from, &to, dry_run);
+
+        // Bump the `html_root_url`.
+        let from = format!(
+            r#"#![doc(html_root_url = "https://docs.rs/microbit-common/{old_version}")]"#,
+            old_version = old_version
+        );
+        let to = format!(
+            r#"#![doc(html_root_url = "https://docs.rs/microbit-common/{new_version}")]"#,
+            new_version = new_version
+        );
+        let librs_path = "microbit-common/src/lib.rs";
+        file_replace(librs_path, &from, &to, dry_run);
+    }
+
+    for (crate_name, _, _) in CRATES {
+        println!("{}: {} -> {}", crate_name, old_version, new_version);
+        let toml_path = format!("{}/Cargo.toml", crate_name);
+
+        // Bump the crate's version.
+        let from = format!(r#"version = "{}""#, old_version);
+        let to = format!(r#"version = "{}""#, new_version);
+        file_replace(&toml_path, &from, &to, dry_run);
+
+        // Bump the crate's dependency on `microbit-common`.
+        let from = format!(r#"version = "={}""#, old_version);
+        let to = format!(r#"version = "={}""#, new_version);
+        file_replace(&toml_path, &from, &to, dry_run);
+
+        // Bump the crate's `html_root_url`.
+        let from = format!(
+            r#"#![doc(html_root_url = "https://docs.rs/{crate}/{old_version}")]"#,
+            crate = crate_name,
+            old_version = old_version
+        );
+        let to = format!(
+            r#"#![doc(html_root_url = "https://docs.rs/{crate}/{new_version}")]"#,
+            crate = crate_name,
+            new_version = new_version
+        );
+        let librs_path = format!("{}/src/lib.rs", crate_name);
+        file_replace(&librs_path, &from, &to, dry_run);
+    }
+}

xtask/src/ci.rs

@@ -0,0 +1,169 @@
+use super::CRATES;
+use std::{collections::HashMap, env, fs, path, process::Command};
+
+pub static DEPENDENCIES: &[&str] = &["flip-link"];
+
+fn install_targets() {
+    let targets = CRATES
+        .iter()
+        .map(|(_, target, _)| *target)
+        .collect::<Vec<_>>();
+
+    let mut rustup = Command::new("rustup");
+    rustup.args(&["target", "add"]).args(&targets);
+    let status = rustup
+        .status()
+        .map_err(|e| format!("couldn't execute {:?}: {}", rustup, e))
+        .unwrap();
+    assert!(
+        status.success(),
+        "failed to install targets with rustup: {:?}",
+        rustup
+    );
+}
+
+/// Install global dependencies
+fn install_dependencies() {
+    for dependency in DEPENDENCIES {
+        let mut cargo = Command::new("cargo");
+        cargo.args(&["install", dependency]);
+        let status = cargo
+            .status()
+            .map_err(|e| format!("couldn't execute {:?}: {}", cargo, e))
+            .unwrap();
+        assert!(status.success(),);
+    }
+}
+
+/// Build-test each board support crate
+fn build_crates() {
+    for (hal, target, _) in CRATES {
+        let mut cargo = Command::new("cargo");
+        let toml_path = format!("{}/Cargo.toml", hal);
+        let status = cargo
+            .args(&["build", "--manifest-path", &toml_path, "--target", target])
+            .status()
+            .map_err(|e| format!("could not execute {:?}: {}", cargo, e))
+            .unwrap();
+        assert!(
+            status.success(),
+            "command exited with error status: {:?}",
+            cargo
+        );
+    }
+}
+
+/// Build/Run doc-tests in `microbit-common` for each version.
+fn build_run_doc_tests() {
+    for (_, _, feature) in CRATES {
+        let mut cargo = Command::new("cargo");
+        let status = cargo
+            .current_dir("microbit-common")
+            .args(&["test", "--features", feature])
+            .status()
+            .map_err(|e| format!("could not execute {:?}: {}", cargo, e))
+            .unwrap();
+        assert!(
+            status.success(),
+            "command exited with error status: {:?}",
+            cargo
+        );
+    }
+}
+
+/// Build all examples with the boards they support
+fn build_examples() {
+    let feature_targets = CRATES
+        .iter()
+        .map(|(_, target, feature)| (feature.to_string(), target.to_string()))
+        .collect::<HashMap<_, _>>();
+
+    let crate_targets = CRATES
+        .iter()
+        .map(|(name, target, _)| (name.to_string(), target.to_string()))
+        .collect::<HashMap<_, _>>();
+
+    for example in fs::read_dir("examples").unwrap() {
+        let dir = example.unwrap();
+        let manifest_path = dir.path().join("Cargo.toml");
+
+        // Skip if there is no manifest
+        if !manifest_path.exists() {
+            continue;
+        }
+
+        let manifest = cargo_toml::Manifest::from_path(&manifest_path).unwrap();
+
+        // find features and their targets supported by the example
+        let mut features = manifest
+            .features
+            .keys()
+            .filter_map(|feature| {
+                feature_targets
+                    .get(feature)
+                    .map(|target| (Some(feature.to_owned()), target.to_owned()))
+            })
+            .collect::<Vec<_>>();
+
+        // if there are no features find the target from the dependencies
+        if features.len() == 0 {
+            features = manifest
+                .dependencies
+                .keys()
+                .filter_map(|name| {
+                    crate_targets
+                        .get(name)
+                        .map(|target| (None, target.to_owned()))
+                })
+                .collect::<Vec<_>>();
+            assert_eq!(
+                features.len(),
+                1,
+                "examples must depend on either microbit or microbit-v2"
+            );
+        }
+
+        for (feature, target) in features {
+            build_example(&manifest_path, feature, target);
+        }
+    }
+}
+
+fn build_example(manifest_path: &path::PathBuf, feature: Option<String>, target: String) {
+    let mut cargo = Command::new("cargo");
+    cargo.args(&[
+        "build",
+        "--target",
+        &target,
+        "--manifest-path",
+        manifest_path.to_str().unwrap(),
+    ]);
+    if let Some(feature) = feature {
+        cargo.args(&["--features", &feature]);
+    }
+
+    let status = cargo
+        .status()
+        .map_err(|e| format!("could not execute {:?}: {}", cargo, e))
+        .unwrap();
+
+    assert!(
+        status.success(),
+        "command exited with error status: {:?}",
+        cargo
+    );
+}
+
+pub fn ci() {
+    install_targets();
+    install_dependencies();
+
+    // move up if we're running from inside xtask
+    if env::current_dir().unwrap().ends_with("xtask") {
+        env::set_current_dir("..").unwrap();
+    }
+
+    build_crates();
+    build_run_doc_tests();
+    build_examples();
+}