Display update changelog if requested on self-update

Cargo.toml

@@ -25,6 +25,9 @@ cli = [
     "dep:console",
     "dep:dialoguer",
     "dep:indicatif",
+    "dep:pulldown-cmark-mdcat",
+    "dep:pulldown-cmark",
+    "dep:syntect",
     "dep:tracing-subscriber",
 ]
 
@@ -85,6 +88,11 @@ clap = { optional = true, version = "4.5", features = ["derive"] }
 console = { optional = true, version = "0.15" }
 dialoguer = { optional = true, version = "0.11" }
 indicatif = { optional = true, version = "0.17" }
+
+pulldown-cmark-mdcat = { optional = true, version = "2.3.0", default-features = false }
+pulldown-cmark = { optional = true, version = "0.9.2" }
+syntect = { optional = true, version = "5.2.0" }
+
 tracing-subscriber = { optional = true, version = "0.3", features = [
     "env-filter",
 ] }

lib/sources/github/mod.rs

@@ -10,7 +10,7 @@ use reqwest::{
 
 use crate::tool::{ToolId, ToolSpec};
 
-use super::{client::create_client, Artifact, ArtifactProvider};
+use super::{client::create_client, source::ReleaseArtifact, Artifact, ArtifactProvider};
 
 const BASE_URL: &str = "https://api.github.com";
 
@@ -128,7 +128,7 @@ impl GithubProvider {
         Fetches the latest release for a given tool.
     */
     #[instrument(skip(self), fields(%tool_id), level = "debug")]
-    pub async fn get_latest_release(&self, tool_id: &ToolId) -> GithubResult<Vec<Artifact>> {
+    pub async fn get_latest_release(&self, tool_id: &ToolId) -> GithubResult<ReleaseArtifact> {
         debug!(id = %tool_id, "fetching latest release for tool");
 
         let url = format!(
@@ -152,14 +152,20 @@ impl GithubProvider {
             .map_err(|e| GithubError::Other(e.to_string()))?;
 
         let tool_spec: ToolSpec = (tool_id.clone(), version).into();
-        Ok(artifacts_from_release(&release, &tool_spec))
+        Ok(ReleaseArtifact {
+            artifacts: artifacts_from_release(&release.clone(), &tool_spec),
+            changelog: release.changelog,
+        })
     }
 
     /**
         Fetches a specific release for a given tool.
     */
     #[instrument(skip(self), fields(%tool_spec), level = "debug")]
-    pub async fn get_specific_release(&self, tool_spec: &ToolSpec) -> GithubResult<Vec<Artifact>> {
+    pub async fn get_specific_release(
+        &self,
+        tool_spec: &ToolSpec,
+    ) -> GithubResult<ReleaseArtifact> {
         debug!(spec = %tool_spec, "fetching release for tool");
 
         let url_with_prefix = format!(
@@ -187,7 +193,10 @@ impl GithubProvider {
             Ok(r) => r,
         };
 
-        Ok(artifacts_from_release(&release, tool_spec))
+        Ok(ReleaseArtifact {
+            artifacts: artifacts_from_release(&release.clone(), tool_spec),
+            changelog: release.changelog,
+        })
     }
 
     /**

lib/sources/github/models.rs

@@ -6,6 +6,8 @@ pub struct Release {
     pub assets: Vec<Asset>,
     pub tag_name: String,
     pub prerelease: bool,
+    #[serde(rename = "body")]
+    pub changelog: Option<String>,
 }
 
 #[derive(Debug, Clone, Deserialize)]

lib/sources/source.rs

@@ -17,6 +17,12 @@ pub struct ArtifactSource {
     github: GithubProvider,
 }
 
+#[derive(Debug, Clone)]
+pub struct ReleaseArtifact {
+    pub changelog: Option<String>,
+    pub artifacts: Vec<Artifact>,
+}
+
 impl ArtifactSource {
     /**
         Creates a new artifact source.
@@ -57,7 +63,7 @@ impl ArtifactSource {
 
         - If the latest release could not be fetched.
     */
-    pub async fn get_latest_release(&self, id: &ToolId) -> RokitResult<Vec<Artifact>> {
+    pub async fn get_latest_release(&self, id: &ToolId) -> RokitResult<ReleaseArtifact> {
         Ok(match id.provider() {
             ArtifactProvider::GitHub => self.github.get_latest_release(id).await?,
         })
@@ -70,7 +76,7 @@ impl ArtifactSource {
 
         - If the specific release could not be fetched.
     */
-    pub async fn get_specific_release(&self, spec: &ToolSpec) -> RokitResult<Vec<Artifact>> {
+    pub async fn get_specific_release(&self, spec: &ToolSpec) -> RokitResult<ReleaseArtifact> {
         Ok(match spec.provider() {
             ArtifactProvider::GitHub => self.github.get_specific_release(spec).await?,
         })

src/cli/add.rs

@@ -85,13 +85,13 @@ impl AddSubcommand {
         let pt = CliProgressTracker::new_with_message("Fetching", 3);
         let (spec, artifact) = match self.tool.clone() {
             ToolIdOrSpec::Spec(spec) => {
-                let artifacts = source.get_specific_release(&spec).await?;
-                let artifact = find_most_compatible_artifact(&artifacts, &id)?;
+                let release_artifact = source.get_specific_release(&spec).await?;
+                let artifact = find_most_compatible_artifact(&release_artifact.artifacts, &id)?;
                 (spec, artifact)
             }
             ToolIdOrSpec::Id(id) => {
-                let artifacts = source.get_latest_release(&id).await?;
-                let artifact = find_most_compatible_artifact(&artifacts, &id)?;
+                let release_artifact = source.get_latest_release(&id).await?;
+                let artifact = find_most_compatible_artifact(&release_artifact.artifacts, &id)?;
                 (artifact.tool_spec.clone(), artifact)
             }
         };

src/cli/install.rs

@@ -81,10 +81,11 @@ impl InstallSubcommand {
                     return anyhow::Ok(tool_spec);
                 }
 
-                let artifacts = source.get_specific_release(&tool_spec).await?;
+                let release_artifact = source.get_specific_release(&tool_spec).await?;
                 pt.subtask_completed();
 
-                let artifact = find_most_compatible_artifact(&artifacts, tool_spec.id())?;
+                let artifact =
+                    find_most_compatible_artifact(&release_artifact.artifacts, tool_spec.id())?;
                 pt.subtask_completed();
 
                 let contents = source

src/cli/self_update.rs

@@ -1,6 +1,15 @@
+use std::io::{stdout, BufWriter};
+
 use anyhow::{bail, Context, Result};
 use clap::Parser;
-use console::style;
+use console::{style, Style};
+use dialoguer::{theme::ColorfulTheme, Confirm};
+use pulldown_cmark::{Options, Parser as MarkdownParser};
+use pulldown_cmark_mdcat::{
+    resources::FileResourceHandler, Environment, Settings, TerminalProgram, TerminalSize, Theme,
+};
+use syntect::parsing::SyntaxSet;
+
 use semver::Version;
 
 use rokit::{storage::Home, tool::ToolId};
@@ -34,11 +43,17 @@ impl SelfUpdateSubcommand {
         pt.task_completed();
         pt.update_message("Fetching");
 
-        let artifacts = source.get_latest_release(&tool_id).await?;
+        let release_artifact = source.get_latest_release(&tool_id).await?;
 
         // Skip updating if we are already on the latest version
         let version_current = env!("CARGO_PKG_VERSION").parse::<Version>().unwrap();
-        let version_latest = artifacts.first().unwrap().tool_spec.version().clone();
+        let version_latest = release_artifact
+            .artifacts
+            .first()
+            .unwrap()
+            .tool_spec
+            .version()
+            .clone();
         if version_current >= version_latest && !self.force {
             let msg = format!(
                 "Rokit is already up-to-date! {}\n\n\
@@ -55,7 +70,7 @@ impl SelfUpdateSubcommand {
         pt.task_completed();
         pt.update_message("Downloading");
 
-        let artifact = find_most_compatible_artifact(&artifacts, &tool_id)
+        let artifact = find_most_compatible_artifact(&release_artifact.artifacts, &tool_id)
             .context("No compatible Rokit artifact was found (WAT???)")?;
         let artifact_contents = source
             .download_artifact_contents(&artifact)
@@ -76,10 +91,10 @@ impl SelfUpdateSubcommand {
 
         let storage = home.tool_storage();
         storage.replace_rokit_contents(binary_contents).await;
-        storage
-            .recreate_all_links()
-            .await
-            .context("Failed to create new tool links")?;
+        // storage
+        //     .recreate_all_links()
+        //     .await
+        //     .context("Failed to create new tool links")?;
 
         // Everything went well, yay!
         let msg = format!(
@@ -91,6 +106,46 @@ impl SelfUpdateSubcommand {
         );
         pt.finish_with_message(msg);
 
+        // If there is a changelog, and the user wants to see it, show it
+        if let Some(changelog) = release_artifact.changelog {
+            let to_show_changelog = Confirm::with_theme(&ColorfulTheme {
+                active_item_prefix: style("📋 ".to_string()),
+                prompt_style: Style::new(),
+                ..Default::default()
+            })
+            .with_prompt("View changelogs for this update?")
+            .interact_opt()?
+            .unwrap_or_default();
+
+            if to_show_changelog {
+                println!();
+                pulldown_cmark_mdcat::push_tty(
+                    &Settings {
+                        terminal_capabilities: TerminalProgram::detect().capabilities(),
+                        terminal_size: TerminalSize::detect()
+                            .context("Failed to detect terminal size")?,
+                        syntax_set: &SyntaxSet::load_defaults_newlines(),
+                        theme: Theme::default(),
+                    },
+                    &Environment::for_local_directory(&tempfile::tempdir()?.path())?,
+                    &FileResourceHandler::new(104_857_600), // TODO: Maybe make this be a DispatchingResourceHandler?
+                    &mut BufWriter::new(stdout()),
+                    MarkdownParser::new_ext(
+                        format!(
+                            "# Changelog - {} v{}\n{}",
+                            tool_id.name(),
+                            version_current,
+                            changelog
+                        )
+                        .as_str(),
+                        Options::ENABLE_FOOTNOTES
+                            | Options::ENABLE_TABLES
+                            | Options::ENABLE_STRIKETHROUGH,
+                    ),
+                )?;
+            }
+        }
+
         Ok(())
     }
 }

src/cli/update.rs

@@ -141,7 +141,7 @@ impl UpdateSubcommand {
                     }
                 };
 
-                let artifact = find_most_compatible_artifact(&artifacts, &id)?;
+                let artifact = find_most_compatible_artifact(&artifacts.artifacts, &id)?;
                 pt.subtask_completed();
 
                 Ok::<_, anyhow::Error>((alias, id, artifact))