Merge pull request #1139 from flavio/change-artifacthub-scaffold

feat!: change how artifacthub scaffold works

Author: viccuad

Cargo.lock

@@ -23,7 +23,7 @@ k8s-openapi = { version = "0.24.0", default-features = false, features = [
 ] }
 lazy_static = "1.4.0"
 pem = "3"
-policy-evaluator = { git = "https://github.com/kubewarden/policy-evaluator", tag = "v0.21.0" }
+policy-evaluator = { git = "https://github.com/kubewarden/policy-evaluator", tag = "v0.22.0" }
 prettytable-rs = "^0.10"
 regex = "1"
 rustls-pki-types = { version = "1", features = ["alloc"] }

Cargo.toml

@@ -388,11 +388,10 @@ Scaffold an AdmissionRequest object
 
 Output an artifacthub-pkg.yml file from a metadata.yml file
 
-**Usage:** `kwctl scaffold artifacthub [OPTIONS] --metadata-path <PATH> --version <VALUE>`
+**Usage:** `kwctl scaffold artifacthub [OPTIONS] --metadata-path <PATH>`
 
 ###### **Options:**
 
-* `-t`, `--gh-release-tag <VALUE>` — Specifies the GitHub release tag of the policy. If set, this tag will be used for generating GitHub release links instead of the version.
 * `-m`, `--metadata-path <PATH>` — File containing the metadata of the policy
 * `-o`, `--output <FILE>` — Path where the artifact-pkg.yml file will be stored
 * `-q`, `--questions-path <PATH>` — File containing the questions-ui content of the policy

cli-docs.md

@@ -423,19 +423,12 @@ fn subcommand_scaffold() -> Command {
             .value_name("PATH")
             .help("File containing the metadata of the policy"),
         Arg::new("version")
-            .required(true)
+            .required(false)
             .long("version")
             .short('v')
             .number_of_values(1)
             .value_name("VALUE")
             .help("Semver version of the policy"),
-        Arg::new("gh-release-tag")
-            .required(false)
-            .long("gh-release-tag")
-            .short('t')
-            .number_of_values(1)
-            .value_name("VALUE")
-            .help("Specifies the GitHub release tag of the policy. If set, this tag will be used for generating GitHub release links instead of the version."),
         Arg::new("questions-path")
             .long("questions-path")
             .short('q')

src/cli.rs

@@ -323,19 +323,13 @@ async fn main() -> Result<()> {
                         .get_one::<String>("metadata-path")
                         .map(|output| PathBuf::from_str(output).unwrap())
                         .unwrap();
-                    let version = artifacthub_matches.get_one::<String>("version").unwrap();
-                    let gh_release_tag = artifacthub_matches
-                        .get_one::<String>("gh-release-tag")
-                        .cloned();
+                    if artifacthub_matches.get_one::<String>("version").is_some() {
+                        tracing::warn!("The 'version' flag is deprecated and will be removed in a future release. The value of the `io.kubewarden.policy.version` field in the policy metadata file is used instead.");
+                    }
                     let questions_file = artifacthub_matches
                         .get_one::<String>("questions-path")
                         .map(|output| PathBuf::from_str(output).unwrap());
-                    let content = scaffold::artifacthub(
-                        metadata_file,
-                        version,
-                        gh_release_tag.as_deref(),
-                        questions_file,
-                    )?;
+                    let content = scaffold::artifacthub(metadata_file, questions_file)?;
                     if let Some(output) = artifacthub_matches.get_one::<String>("output") {
                         let output_path = PathBuf::from_str(output)?;
                         fs::write(output_path, content)?;

src/main.rs

@@ -8,8 +8,6 @@ use time::OffsetDateTime;
 
 pub(crate) fn artifacthub(
     metadata_path: PathBuf,
-    version: &str,
-    gh_release_tag: Option<&str>,
     questions_path: Option<PathBuf>,
 ) -> Result<String> {
     let comment_header = r#"# Kubewarden Artifacthub Package config
@@ -29,13 +27,8 @@ pub(crate) fn artifacthub(
         })
         .transpose()?;
 
-    let kubewarden_artifacthub_pkg = ArtifactHubPkg::from_metadata(
-        &metadata,
-        version,
-        gh_release_tag,
-        OffsetDateTime::now_utc(),
-        questions.as_deref(),
-    )?;
+    let kubewarden_artifacthub_pkg =
+        ArtifactHubPkg::from_metadata(&metadata, OffsetDateTime::now_utc(), questions.as_deref())?;
 
     Ok(format!(
         "{}\n{}",