Skip to content

fix(preset): remove unnecessary mutable reference warning #169

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
fohte merged 2 commits into from
Mar 8, 2026
Merged

fix(preset): remove unnecessary mutable reference warning #169

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ae9606
refactor(preset): remove mutable reference warning for preset loading
fohte Mar 8, 2026
ea44917
docs: remove mutable preset reference warning documentation
fohte Mar 8, 2026
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
37 changes: 0 additions & 37 deletions src/config/preset_remote.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@ impl GitHubVersion {
matches!(self, Self::CommitSha(_))
}

/// Whether this is a mutable reference that should trigger a warning.
pub fn is_mutable(&self) -> bool {
!self.is_immutable()
}

/// Convert to a git ref string for `--branch` or `checkout`.
pub fn as_git_ref(&self) -> Option<&str> {
match self {
Expand Down Expand Up @@ -263,23 +258,6 @@ fn resolve_git_params(reference: &PresetReference) -> GitParams {
}
}

/// Emit a warning to stderr if the reference is mutable.
fn emit_mutable_warning(reference: &PresetReference, original: &str) {
let is_mutable = match reference {
PresetReference::GitHub { version, .. } => version.is_mutable(),
PresetReference::GitUrl { git_ref, .. } => {
git_ref.as_deref().is_none_or(|r| !is_commit_sha(r))
}
PresetReference::Local(_) => false,
};
if is_mutable {
eprintln!(
"warning: Mutable preset reference '{original}'\n \
Consider pinning to a commit SHA for reproducibility"
);
}
}

/// Read a preset config file from a directory.
///
/// When `preset_path` is `None`, reads `runok.yml` (or `runok.yaml`) from the root.
Expand Down Expand Up @@ -356,8 +334,6 @@ pub fn load_remote_preset<G: GitClient>(
git_client: &G,
cache: &PresetCache,
) -> Result<Config, ConfigError> {
emit_mutable_warning(reference, original_reference);

let params = resolve_git_params(reference);
let cache_dir = cache.cache_dir(original_reference);
let preset_path = preset_path_from_reference(reference);
Expand Down Expand Up @@ -653,19 +629,6 @@ mod tests {
assert_eq!(is_commit_sha(input), expected);
}

// === GitHubVersion mutability ===

#[rstest]
#[case::sha_immutable(
GitHubVersion::CommitSha("abc1234def567890abc1234def567890abc12345".into()),
false
)]
#[case::tag_mutable(GitHubVersion::Tag("v1.0.0".into()), true)]
#[case::latest_mutable(GitHubVersion::Latest, true)]
fn version_mutability(#[case] version: GitHubVersion, #[case] expected_mutable: bool) {
assert_eq!(version.is_mutable(), expected_mutable);
}

// === GitHub shorthand → git URL conversion ===

#[rstest]
Expand Down
Loading