Skip to content

xtask: Add SemVer checks for esp-rom-sys #4584

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

Open
JurajSadel wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −1
Open

xtask: Add SemVer checks for esp-rom-sys #4584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions esp-rom-sys/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ license = "MIT OR Apache-2.0"
links = "esp_rom_sys"

[package.metadata.espressif]
semver-checked = true
forever-unstable = true
check-configs = [{ features = [] }]
clippy-configs = [{ features = [] }]
Expand Down
24 changes: 23 additions & 1 deletion xtask/src/semver_check.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use std::{
use anyhow::{Context, Error};
use cargo_semver_checks::{Check, GlobalConfig, ReleaseType, Rustdoc};
use esp_metadata::{Chip, Config};
use toml_edit::{Item, Value};

use crate::{Package, cargo::CargoArgsBuilder, commands::checker::download_baselines};

Expand Down Expand Up @@ -46,7 +47,6 @@ pub fn minimum_update(
let mut cfg = GlobalConfig::new();
cfg.set_log_level(Some(log::Level::Info));
let result = semver_check.check_release(&mut cfg)?;
log::info!("Result {:?}", result);

let mut min_required_update = ReleaseType::Patch;
for (_, report) in result.crate_reports() {
Expand All @@ -59,6 +59,28 @@ pub fn minimum_update(
}
}

let forever_unstable = package
Copy link
Contributor

@bjoernQ bjoernQ Dec 3, 2025

Choose a reason for hiding this comment

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

not necessarily something which needs to be done in this PR but we could have a forever_unstable() method on Package - we now have this piece of code duplicated

Copy link
Member

@MabezDev MabezDev Dec 3, 2025

Choose a reason for hiding this comment

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

imo this should be done here, as its the first copy of the original. Let's refactor this now.

.toml()
.espressif_metadata()
.and_then(|metadata| metadata.get("forever-unstable"))
.map(|item| match item {
Item::Value(Value::Boolean(b)) => *b.value(),
Item::Value(_) => {
log::warn!("Invalid value for 'forever-unstable' in metadata - must be a boolean");
true
}
_ => false,
})
.unwrap_or(false);

if forever_unstable && min_required_update == ReleaseType::Major {
log::warn!(
"Downgrading required bump from Minor to Patch for unstable package: {}",
package
);
min_required_update = ReleaseType::Minor;
}

Ok(min_required_update)
}

Expand Down
Loading