Merge pull request #165 from cooklang/chore/optional-self-update

fix: make self-update optional

Author: dubadub

.github/workflows/test.yml

@@ -88,6 +88,10 @@ jobs:
       run: cargo build --release --verbose
       if: matrix.rust == 'stable'
 
+    - name: Build without self-update feature
+      run: cargo build --release --no-default-features --verbose
+      if: matrix.rust == 'stable'
+
   coverage:
     name: Code Coverage
     runs-on: ubuntu-latest

Cargo.toml

@@ -6,6 +6,10 @@ description = "A command-line interface for managing and working with Cooklang r
 license = "MIT"
 include = ["/src", "/Cargo.toml", "/Cargo.lock", "/README.md", "/templates", "/static"]
 
+[features]
+default = ["self-update"]
+self-update = ["dep:self_update"]
+
 [lib]
 name = "cookcli"
 path = "src/lib.rs"
@@ -40,7 +44,7 @@ openssl = { version = "0.10", features = ["vendored"] }
 regex = "1"
 rust-embed = "8"
 scraper = "0.20"
-self_update = { version = "0.41", default-features = false, features = ["archive-tar", "archive-zip", "compression-flate2", "rustls"] }
+self_update = { version = "0.41", default-features = false, features = ["archive-tar", "archive-zip", "compression-flate2", "rustls"], optional = true }
 serde = "1.0"
 serde_json = "1.0"
 serde_yaml = "0.9"

README.md

@@ -124,6 +124,23 @@ cargo build --release
 # Binary will be at target/release/cook
 ```
 
+#### Building without Self-Update
+
+By default, CookCLI includes a self-update feature. To build without this feature (useful for CI/CD pipelines, package managers, or environments where auto-update is not desired):
+
+```bash
+# Build without self-update feature
+cargo build --release --no-default-features
+
+# This disables the 'self-update' feature flag while keeping all other functionality
+```
+
+Use cases for disabling self-update:
+* Package manager distributions (Homebrew, apt, etc.)
+* CI/CD pipelines where version control is managed externally
+* Corporate environments with restricted network access
+* When distributing through official release channels
+
 ### Development Setup
 
 For development with hot-reload of CSS changes:

src/args.rs

@@ -30,7 +30,9 @@
 
 use clap::{Parser, Subcommand};
 
-use crate::{doctor, import, pantry, recipe, report, search, seed, server, shopping_list, update};
+#[cfg(feature = "self-update")]
+use crate::update;
+use crate::{doctor, import, pantry, recipe, report, search, seed, server, shopping_list};
 
 #[derive(Parser, Debug)]
 #[command(
@@ -201,9 +203,11 @@ pub enum Command {
     ///   cook update                     # Download and install latest version
     ///   cook update --check-only        # Check for updates without installing
     ///   cook update --force             # Force reinstall even if up to date
+    #[cfg(feature = "self-update")]
     #[command(
         alias = "u",
         long_about = "Check for and install updates to CookCLI from GitHub releases"
     )]
+    #[cfg(feature = "self-update")]
     Update(update::UpdateArgs),
 }

src/doctor.rs

@@ -108,8 +108,17 @@ pub fn run(ctx: &Context, args: DoctorArgs) -> Result<()> {
             println!("Running all doctor checks...\n");
 
             // Check for updates
-            println!("=== Version Check ===");
-            check_for_updates();
+            #[cfg(feature = "self-update")]
+            {
+                println!("=== Version Check ===");
+                check_for_updates();
+            }
+            #[cfg(not(feature = "self-update"))]
+            {
+                println!("=== Version Check ===");
+                println!("ℹ️  Self-update is disabled in this build.");
+                println!("   Please update through your package manager or build from source.");
+            }
 
             println!("\n=== Recipe Validation ===");
             run_validate(
@@ -131,6 +140,7 @@ pub fn run(ctx: &Context, args: DoctorArgs) -> Result<()> {
     }
 }
 
+#[cfg(feature = "self-update")]
 fn check_for_updates() {
     match crate::update::check_for_updates() {
         Ok(Some(new_version)) => {

src/lib.rs

@@ -11,6 +11,7 @@ pub mod search;
 pub mod seed;
 pub mod server;
 pub mod shopping_list;
+#[cfg(feature = "self-update")]
 pub mod update;
 
 // Other modules

src/main.rs

@@ -44,6 +44,7 @@ mod search;
 mod seed;
 mod server;
 mod shopping_list;
+#[cfg(feature = "self-update")]
 mod update;
 
 // other modules
@@ -72,6 +73,7 @@ pub fn main() -> Result<()> {
         Command::Report(args) => report::run(&ctx, args),
         Command::Doctor(args) => doctor::run(&ctx, args),
         Command::Pantry(args) => pantry::run(&ctx, args),
+        #[cfg(feature = "self-update")]
         Command::Update(args) => update::run(args),
     }
 }