refactor: make source identifiers consistent

Author: marekzan

core/src/artifact/source/artifacthub.rs

@@ -6,7 +6,7 @@ use serde::Deserialize;
 
 #[derive(Deserialize, Debug, Clone)]
 pub struct ArtifactHubSource {
-    pub package: String,
+    pub identifier: String,
 }
 
 #[derive(Deserialize, Debug)]
@@ -18,7 +18,7 @@ const ARTIFACTHUB_API: &str = "https://artifacthub.io/api/v1/packages";
 
 impl SourceChecker for ArtifactHubSource {
     async fn is_version_behind(&self, current_version: &str) -> Result<Option<String>> {
-        let source = format!("{}/{}", ARTIFACTHUB_API, &self.package);
+        let source = format!("{}/{}", ARTIFACTHUB_API, &self.identifier);
 
         let response = get(&source)
             .await

core/src/artifact/source/dockerhub.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Deserialize, Debug, Clone)]
 pub struct DockerHubSource {
-    pub repo: String,
+    pub identifier: String,
 }
 
 #[derive(Serialize, Deserialize, Debug)]
@@ -28,7 +28,7 @@ const PAGE_SIZE_QUERY_PARAM: &str = "page_size=200";
 
 impl SourceChecker for DockerHubSource {
     async fn is_version_behind(&self, current_version: &str) -> Result<Option<String>> {
-        let source = build_dockerhub_url(&self.repo);
+        let source = build_dockerhub_url(&self.identifier);
         let response = fetch_dockerhub_tags(&source).await?;
 
         // TODO: we need to fetch the next results of the paginated response

core/src/artifact/source/github.rs

@@ -5,7 +5,7 @@ use serde::Deserialize;
 
 #[derive(Deserialize, Debug, Clone)]
 pub struct GitHubSource {
-    pub repo: String,
+    pub identifier: String,
 }
 
 #[derive(Deserialize)]
@@ -17,7 +17,7 @@ const GITHUB_API: &str = "https://api.github.com/repos";
 
 impl SourceChecker for GitHubSource {
     async fn is_version_behind(&self, current_version: &str) -> Result<Option<String>> {
-        let source = format!("{}/{}/releases/latest", GITHUB_API, self.repo);
+        let source = format!("{}/{}/releases/latest", GITHUB_API, self.identifier);
 
         // Send the HTTP request
         let response = get(&source)

core/src/config.rs

@@ -120,7 +120,7 @@ mod tests {
             message_prefix: None,
             notifier: vec!["notifier1".to_string(), "notifier2".to_string()],
             source: Source::GitHub(crate::artifact::source::github::GitHubSource {
-                repo: "repo".to_string(),
+                identifier: "repo".to_string(),
             }),
             current_version: "1.0.0".to_string(),
             sink: vec![],
@@ -160,7 +160,7 @@ mod tests {
             message_prefix: None,
             notifier: vec![],
             source: Source::GitHub(crate::artifact::source::github::GitHubSource {
-                repo: "repo".to_string(),
+                identifier: "repo".to_string(),
             }),
             current_version: "1.0.0".to_string(),
             sink: vec![],
@@ -184,7 +184,7 @@ mod tests {
             message_prefix: None,
             notifier: vec!["notifier1".to_string(), "notifier2".to_string()],
             source: Source::GitHub(crate::artifact::source::github::GitHubSource {
-                repo: "repo".to_string(),
+                identifier: "repo".to_string(),
             }),
             current_version: "1.0.0".to_string(),
             sink: vec![],

examples/CONFIG.md

@@ -10,15 +10,15 @@
 
 ### GitHub
 
-For the repo value you just take the part of the url with the `username/reponame`
+For the identifier value you just take the part of the url with the `username/reponame`
 
 ```
 {
   "name": "Rust",
   "message_prefix": "There is a new version of:", // optional
   "source": {
     "type": "github",
-    "repo": "rust-lang/rust"
+    "identifier": "rust-lang/rust"
   },
   "current_version": "",
   "notifier": ["team_slack", "private_email"]
@@ -27,7 +27,7 @@ For the repo value you just take the part of the url with the `username/reponame
 
 ### Artifacthub
 
-For the package value you just take the part of the url with the `kind/organization/packagename`
+For the identifier value you just take the part of the url with the `kind/organization/packagename`
 
 ```
 {
@@ -36,15 +36,15 @@ For the package value you just take the part of the url with the `kind/organizat
   "current_version": "24.3.1",
   "source": {
     "type": "artifacthub",
-    "package": "helm/bitnami/keycloak"
+    "identifier": "helm/bitnami/keycloak"
   },
   "notifier": ["generic_webhook", "team_google_chat"]
 },
 ```
 
 ### Dockerhub
 
-For the repo you just take the part of the url with the `username/imagename`.
+For the identifier value you just take the part of the url with the `username/imagename`.
 Official images have a special syntax `_/nginx` for example. For these you just use the image name `nginx`.
 
 ```
@@ -54,7 +54,7 @@ Official images have a special syntax `_/nginx` for example. For these you just
   "current_version": "1.25.2-alpine3.20-perl",
   "source": {
     "type": "dockerhub",
-    "repo": "nginx"
+    "identifier": "nginx"
   },
   "notifier": ["private_email"]
 }