docyard 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe9582d35d963462ff818674735f3b131607368f6adc6fdb70eac6152365efe8
-  data.tar.gz: a8e8b424702b4ca3ff2726a938ea0696f0b15bed3d82f449f803f64923bbbafc
+  metadata.gz: 4892fa130361d02f347660d81932135f00c71d339c28b292e7bfecbe46ededa0
+  data.tar.gz: 4697d95492f675b935db0dad134c11eb0d57f7aca611dd25c3e4e22bded9f031
 SHA512:
-  metadata.gz: 4c6ae9f9e88f186d43aa13ef62c2c96d3c4ed65e0320558413df73915bd33478b673dae25dc4f3e3fdf6b0fe627ca595a8fc53cded6186ed3afb03ae08ef7f5d
-  data.tar.gz: 17ad431713b55f78b87a67b5de17db1e58c949895a08ff9d31b6f658aa277a8df8cab84f3d3ee178f9c70a9eb30557089fc0b732e2793b6c9b3c8054bf513b1c
+  metadata.gz: 342e2e7f16c32da9da273b6325532ad8ee842d58304faf309a0e634be5f7c2d3a6a8c5eb0176b09e0b518a67150c25223b5ad3be9c67da90e974e4be9871e28e
+  data.tar.gz: 2f1b65cde20d044348908884fbfd0a185d47d6ef73d9fdd516e5f11792262700550bb70d6ec7523dc910dcaed864d2df51bf6f54480997092c63dfe926b6629d

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2026-02-17
+
+### Added
+- **Deploy Command** - One-command deployment with `docyard deploy` supporting Vercel, Netlify, Cloudflare Pages, and GitHub Pages (#153)
+- **Platform Auto-Detection** - Automatically detects deployment platform from project config files (e.g. `vercel.json`, `netlify.toml`)
+
+### Documentation
+- Added Deploy Command page with per-platform setup instructions
+- Updated CLI reference with `docyard deploy` options
+- Cross-linked existing GitHub Pages, Vercel, and Netlify docs to deploy command
+
 ## [1.2.0] - 2026-02-03
 
 ### Added
@@ -264,7 +275,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial gem structure
 - Project scaffolding
 
-[Unreleased]: https://github.com/sanifhimani/docyard/compare/v1.2.0...HEAD
+[Unreleased]: https://github.com/sanifhimani/docyard/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/sanifhimani/docyard/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/sanifhimani/docyard/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/sanifhimani/docyard/compare/v1.0.2...v1.1.0
 [1.0.2]: https://github.com/sanifhimani/docyard/compare/v1.0.1...v1.0.2

data/lib/docyard/cli.rb

@@ -80,6 +80,23 @@ module Docyard
       exit(doctor.run)
     end
 
+    desc "deploy", "Deploy the built site to a hosting platform"
+    method_option :to, type: :string, desc: "Target platform (vercel, netlify, cloudflare, github-pages)"
+    method_option :prod, type: :boolean, default: true, desc: "Deploy to production"
+    method_option :skip_build, type: :boolean, default: false, desc: "Skip building before deploy"
+    def deploy
+      apply_global_options
+      require_relative "deploy/deployer"
+      deployer = Deploy::Deployer.new(
+        to: options[:to],
+        production: options[:prod],
+        skip_build: options[:skip_build]
+      )
+      exit(1) unless deployer.deploy
+    rescue ConfigError => e
+      print_config_error(e)
+    end
+
     desc "customize", "Generate theme customization files"
     method_option :minimal, type: :boolean, default: false, aliases: "-m",
                             desc: "Generate minimal files without comments"

data/lib/docyard/deploy/adapters/base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Docyard
+  module Deploy
+    module Adapters
+      class Base
+        attr_reader :output_dir, :production, :config
+
+        def initialize(output_dir:, production:, config:)
+          @output_dir = output_dir
+          @production = production
+          @config = config
+        end
+
+        def deploy
+          check_cli_installed!
+          run_deploy
+        end
+
+        def platform_name
+          raise NotImplementedError
+        end
+
+        private
+
+        def cli_name
+          raise NotImplementedError
+        end
+
+        def cli_install_hint
+          raise NotImplementedError
+        end
+
+        def run_deploy
+          raise NotImplementedError
+        end
+
+        def check_cli_installed!
+          _, _, status = Open3.capture3("which", cli_name)
+          return if status.success?
+
+          raise DeployError, "'#{cli_name}' CLI not found. Install it with: #{cli_install_hint}"
+        end
+
+        def execute_command(*)
+          stdout, stderr, status = Open3.capture3(*)
+          return stdout if status.success?
+
+          raise DeployError, "Deploy command failed: #{stderr.strip.empty? ? stdout.strip : stderr.strip}"
+        end
+      end
+    end
+  end
+end

data/lib/docyard/deploy/adapters/cloudflare.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Docyard
+  module Deploy
+    module Adapters
+      class Cloudflare < Base
+        def platform_name
+          "Cloudflare Pages"
+        end
+
+        private
+
+        def cli_name
+          "wrangler"
+        end
+
+        def cli_install_hint
+          "npm i -g wrangler"
+        end
+
+        def run_deploy
+          output = execute_command("wrangler", "pages", "deploy", output_dir, "--project-name=#{project_name}")
+          extract_url(output)
+        end
+
+        def project_name
+          config.title.downcase.gsub(/[^a-z0-9]+/, "-").gsub(/\A-|-\z/, "")
+        end
+
+        def extract_url(output)
+          output.match(%r{https://\S+\.pages\.dev\S*})&.to_s
+        end
+      end
+    end
+  end
+end

data/lib/docyard/deploy/adapters/github_pages.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "fileutils"
+require_relative "base"
+
+module Docyard
+  module Deploy
+    module Adapters
+      class GithubPages < Base
+        def platform_name
+          "GitHub Pages"
+        end
+
+        private
+
+        def cli_name
+          "gh"
+        end
+
+        def cli_install_hint
+          "https://cli.github.com"
+        end
+
+        def run_deploy
+          remote_url = fetch_remote_url
+          Dir.mktmpdir do |tmp|
+            prepare_deploy_dir(tmp)
+            push_to_gh_pages(tmp, remote_url)
+          end
+          build_pages_url(remote_url)
+        end
+
+        def fetch_remote_url
+          execute_command("git", "remote", "get-url", "origin").strip
+        end
+
+        def prepare_deploy_dir(tmp)
+          FileUtils.cp_r("#{output_dir}/.", tmp)
+          execute_command("git", "-C", tmp, "init", "-b", "gh-pages")
+          execute_command("git", "-C", tmp, "add", ".")
+          execute_command("git", "-C", tmp, "commit", "-m", "Deploy via docyard")
+        end
+
+        def push_to_gh_pages(tmp, remote_url)
+          execute_command("git", "-C", tmp, "remote", "add", "origin", remote_url)
+          execute_command("git", "-C", tmp, "push", "--force", "origin", "gh-pages")
+        end
+
+        def build_pages_url(remote_url)
+          match = remote_url.match(%r{github\.com[:/]([^/]+)/([^/.]+)})
+          return nil unless match
+
+          owner, repo = match.captures
+          "https://#{owner}.github.io/#{repo}/"
+        end
+      end
+    end
+  end
+end

data/lib/docyard/deploy/adapters/netlify.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Docyard
+  module Deploy
+    module Adapters
+      class Netlify < Base
+        def platform_name
+          "Netlify"
+        end
+
+        private
+
+        def cli_name
+          "netlify"
+        end
+
+        def cli_install_hint
+          "npm i -g netlify-cli"
+        end
+
+        def run_deploy
+          args = ["netlify", "deploy", "--dir=#{output_dir}"]
+          args << "--prod" if production
+          output = execute_command(*args)
+          extract_url(output)
+        end
+
+        def extract_url(output)
+          pattern = production ? /Website URL:\s+(\S+)/ : /Website draft URL:\s+(\S+)/
+          output.match(pattern)&.captures&.first
+        end
+      end
+    end
+  end
+end

data/lib/docyard/deploy/adapters/vercel.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Docyard
+  module Deploy
+    module Adapters
+      class Vercel < Base
+        def platform_name
+          "Vercel"
+        end
+
+        private
+
+        def cli_name
+          "vercel"
+        end
+
+        def cli_install_hint
+          "npm i -g vercel"
+        end
+
+        def run_deploy
+          args = ["vercel", output_dir, "--yes"]
+          args << "--prod" if production
+          output = execute_command(*args)
+          extract_url(output)
+        end
+
+        def extract_url(output)
+          output.strip.lines.last&.strip
+        end
+      end
+    end
+  end
+end

data/lib/docyard/deploy/deployer.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "platform_detector"
+require_relative "adapters/vercel"
+require_relative "adapters/netlify"
+require_relative "adapters/cloudflare"
+require_relative "adapters/github_pages"
+
+module Docyard
+  module Deploy
+    class Deployer
+      ADAPTERS = {
+        "vercel" => Adapters::Vercel,
+        "netlify" => Adapters::Netlify,
+        "cloudflare" => Adapters::Cloudflare,
+        "github-pages" => Adapters::GithubPages
+      }.freeze
+
+      attr_reader :config, :platform, :production, :skip_build
+
+      def initialize(to: nil, production: true, skip_build: false)
+        @config = Config.new
+        @platform = to
+        @production = production
+        @skip_build = skip_build
+      end
+
+      def deploy
+        print_header
+        ensure_build
+        adapter = resolve_adapter
+        print_deploy_info(adapter)
+        url = adapter.deploy
+        print_success(url)
+        true
+      rescue DeployError => e
+        print_error(e)
+        false
+      end
+
+      private
+
+      def print_header
+        puts
+        puts "  #{UI.bold('Docyard')} v#{VERSION}"
+        puts "  Deploying..."
+        puts
+      end
+
+      def ensure_build
+        return if skip_build
+
+        require_relative "../builder"
+        builder = Builder.new
+        raise DeployError, "Build failed" unless builder.build
+      end
+
+      def resolve_adapter
+        name = platform || detect_platform
+        adapter_class = ADAPTERS[name]
+        raise DeployError, "Unknown platform: #{name}. Valid options: #{ADAPTERS.keys.join(', ')}" unless adapter_class
+
+        adapter_class.new(output_dir: config.build.output, production: production, config: config)
+      end
+
+      def detect_platform
+        detected = PlatformDetector.new.detect
+        return detected if detected
+
+        raise DeployError,
+              "Could not detect platform. Use --to to specify one: #{ADAPTERS.keys.join(', ')}"
+      end
+
+      def print_deploy_info(adapter)
+        environment = production ? "production" : "preview"
+        puts "  #{UI.dim('Platform')}        #{adapter.platform_name}"
+        puts "  #{UI.dim('Environment')}     #{environment}"
+        puts "  #{UI.dim('Directory')}       #{config.build.output}/"
+        puts
+      end
+
+      def print_success(url)
+        puts "  #{UI.success('Deployed successfully')}"
+        puts "  #{url}" if url
+        puts
+      end
+
+      def print_error(error)
+        puts "  #{UI.error('Deploy failed')}"
+        puts "  #{error.message}"
+        puts
+      end
+    end
+  end
+end

data/lib/docyard/deploy/platform_detector.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Docyard
+  module Deploy
+    class PlatformDetector
+      DETECTION_RULES = [
+        { files: ["vercel.json"], dirs: [".vercel"], platform: "vercel" },
+        { files: ["netlify.toml"], dirs: [".netlify"], platform: "netlify" },
+        { files: ["wrangler.toml", "wrangler.jsonc"], dirs: [], platform: "cloudflare" },
+        { files: [], dirs: [".github/workflows"], platform: "github-pages" }
+      ].freeze
+
+      def initialize(project_root = Dir.pwd)
+        @project_root = project_root
+      end
+
+      def detect
+        DETECTION_RULES.each do |rule|
+          return rule[:platform] if matches?(rule)
+        end
+        nil
+      end
+
+      private
+
+      def matches?(rule)
+        rule[:files].any? { |f| File.exist?(File.join(@project_root, f)) } ||
+          rule[:dirs].any? { |d| Dir.exist?(File.join(@project_root, d)) }
+      end
+    end
+  end
+end

data/lib/docyard/errors.rb

@@ -8,4 +8,6 @@ module Docyard
   class SidebarConfigError < Error; end
 
   class BuildError < Error; end
+
+  class DeployError < Error; end
 end

data/lib/docyard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docyard
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sanif Himani
@@ -245,6 +245,13 @@ files:
 - lib/docyard/config/validator.rb
 - lib/docyard/constants.rb
 - lib/docyard/customizer.rb
+- lib/docyard/deploy/adapters/base.rb
+- lib/docyard/deploy/adapters/cloudflare.rb
+- lib/docyard/deploy/adapters/github_pages.rb
+- lib/docyard/deploy/adapters/netlify.rb
+- lib/docyard/deploy/adapters/vercel.rb
+- lib/docyard/deploy/deployer.rb
+- lib/docyard/deploy/platform_detector.rb
 - lib/docyard/diagnostic.rb
 - lib/docyard/diagnostic_context.rb
 - lib/docyard/doctor.rb