capistrano-dockerbuild 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20a884c1147fd81d4f831378fd286fedf5498d4a
-  data.tar.gz: 227ca91c65a6227320fb8b275befc12cca072ba1
+SHA256:
+  metadata.gz: 7580dbb05690bf6529b2fa5c84cf8c31c8d38b3335858af7aa3afdfcda8a8d7d
+  data.tar.gz: 691b01a48a7ff2aca50ca20ddcfd93275bc5b77ce27f43e7843564fbeac61d83
 SHA512:
-  metadata.gz: a3ee23aff127683494ba9ddd071492e4d197b3a21e9ff400924e99017d9f2d82379beeba57802e2071c95048b5d56d508e7ee08e243f66f7a881576dc699cb1a
-  data.tar.gz: 273a531f78913872dd10e2ebf288f16978e3dde3bbbaba9e273c4dccf22aadaa2ead72599329badc3b7aefd7a45c1090ae6d7fccd77bb47be0b79c36dbde354c
+  metadata.gz: e5a7110eb23e53fd10aa05df4520690637e41a08847b788dd510f7b6ec5b8f48a2ff8919431873ce3e0f15b68ad5e07d0296aff8d4f13503bfacb38946eb0751
+  data.tar.gz: a94036ec200c90d80fe321cbb1519e52c933a09d2db08a292d4375b96fd32a072e4c622af238faa85b2d39aa0a6c85255c5be52ea65f69a1abc38fbcb46183f6

data/README.md

@@ -50,7 +50,24 @@ Use common variables
 | docker_remote_tag             | no       | `-> { fetch(:docker_tag) }`                                                                                        | Use by `docker push docker_registry/docker_remote_repository_name:{{docker_remote_tag}}` |
 | docker_remote_tag_full        | no       | `-> { "#{fetch(:docker_registry) &.+ "/"}#{fetch(:docker_remote_repository_name)}:#{fetch(:docker_remote_tag)}" }` | Use by `docker push {{docker_remote_tag_full}}`                                          |
 | keep_docker_image_count       | no       | 10                                                                                                                 |                                                                                          |
+| git_http_username             | no       | nil                                                                                                                | See below                                                                                |
+| git_http_password             | no       | nil                                                                                                                | See below                                                                                |
 
+If you want to use GitHub Apps installation access token or something to authorize repository access using HTTPS protocol. You can set variables in your config/deploy.rb:
+
+```ruby
+set :git_http_username, -> { ENV["GIT_HTTP_USERNAME"] }
+set :git_http_password, -> { ENV["GIT_HTTP_PASSWORD"] }
+set :repo_url, -> do
+  if fetch(:git_http_username) && fetch(:git_http_password)
+    "https://github.com/owner/repo.git"
+  else
+    "git@github.com:owner/repo.git"
+  end
+end
+```
+
+Update remote URL always if you set proper value to all of `repo_url`, `git_http_username`, and `git_http_password`.
 
 ## Tasks
 

data/capistrano-dockerbuild.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-dockerbuild"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.1"
   spec.authors       = ["joker1007"]
   spec.email         = ["kakyoin.hierophant@gmail.com"]
 
@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "capistrano", ">= 3.2"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

data/lib/capistrano/dockerbuild.rb

@@ -1,3 +1,6 @@
+require "cgi"
+require "uri"
+
 class Capistrano::Dockerbuild < Capistrano::Plugin
   def set_defaults
     set_if_empty :docker_build_cmd, -> { [:docker, "build", "-t", fetch(:docker_tag_full), "."] }
@@ -7,7 +10,10 @@ class Capistrano::Dockerbuild < Capistrano::Plugin
     set_if_empty :docker_remote_repository_name, -> { fetch(:docker_repository_name) }
     set_if_empty :docker_remote_tag, -> { fetch(:docker_tag) }
     set_if_empty :docker_remote_tag_full, -> { "#{fetch(:docker_registry) &.+ "/"}#{fetch(:docker_remote_repository_name)}:#{fetch(:docker_remote_tag)}" }
+    set_if_empty :docker_latest_tag, false
     set_if_empty :keep_docker_image_count, 10
+    set_if_empty :git_gc_prune_date, "3.days.ago"
+    set_if_empty :docker_build_no_worktree, false
   end
 
   def define_tasks
@@ -18,4 +24,19 @@ class Capistrano::Dockerbuild < Capistrano::Plugin
     raise "Need to set :docker_build_base_dir" unless fetch(:docker_build_base_dir)
     Pathname(fetch(:docker_build_base_dir))
   end
+
+  def git_repo_url
+    if fetch(:git_http_username) && fetch(:git_http_password)
+      URI.parse(repo_url).tap do |repo_uri|
+        repo_uri.user     = fetch(:git_http_username)
+        repo_uri.password = CGI.escape(fetch(:git_http_password))
+      end.to_s
+    elsif fetch(:git_http_username)
+      URI.parse(repo_url).tap do |repo_uri|
+        repo_uri.user = fetch(:git_http_username)
+      end.to_s
+    else
+      repo_url
+    end
+  end
 end

data/lib/capistrano/tasks/docker.rake

@@ -5,18 +5,28 @@ namespace :docker do
   task :check do
     on fetch(:docker_build_server_host) do
       execute :mkdir, "-p", dockerbuild_plugin.docker_build_base_path.dirname.to_s
-      execute :git, :'ls-remote', repo_url, "HEAD"
+      execute :git, :'ls-remote', dockerbuild_plugin.git_repo_url, "HEAD"
     end
   end
 
   desc "Clone the repo to docker build base directory"
   task :clone => [:'docker:check'] do
     on fetch(:docker_build_server_host) do
-      if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/HEAD ] "
-        info t(:mirror_exists, at: dockerbuild_plugin.docker_build_base_path.to_s)
+      if fetch(:docker_build_no_worktree)
+        if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/.git/HEAD ] "
+          info "The repository is at #{dockerbuild_plugin.docker_build_base_path}"
+        else
+          within dockerbuild_plugin.docker_build_base_path.dirname do
+            execute :git, :clone, dockerbuild_plugin.git_repo_url, dockerbuild_plugin.docker_build_base_path.to_s
+          end
+        end
       else
-        within dockerbuild_plugin.docker_build_base_path.dirname do
-          execute :git, :clone, "--mirror", repo_url, dockerbuild_plugin.docker_build_base_path.to_s
+        if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/HEAD ] "
+          info t(:mirror_exists, at: dockerbuild_plugin.docker_build_base_path.to_s)
+        else
+          within dockerbuild_plugin.docker_build_base_path.dirname do
+            execute :git, :clone, "--mirror", dockerbuild_plugin.git_repo_url, dockerbuild_plugin.docker_build_base_path.to_s
+          end
         end
       end
     end
@@ -26,6 +36,7 @@ namespace :docker do
   task update_mirror: :'docker:clone' do
     on fetch(:docker_build_server_host) do
       within dockerbuild_plugin.docker_build_base_path do
+        execute :git, :remote, "set-url", :origin, dockerbuild_plugin.git_repo_url
         execute :git, :remote, :update, "--prune"
       end
     end
@@ -35,20 +46,26 @@ namespace :docker do
   task :build => [:'docker:update_mirror'] do
     on fetch(:docker_build_server_host) do
       within dockerbuild_plugin.docker_build_base_path do
-        timestamp = Time.now.to_i
-        worktree_dir_name = "worktree-#{fetch(:docker_tag)}-#{timestamp}"
+        if fetch(:docker_build_no_worktree)
+          commands = "sha1=$(git rev-parse #{fetch(:branch)}); git reset --hard ${sha1}; #{fetch(:docker_build_cmd).map {|c| c.to_s.shellescape }.join(" ")}"
+          execute(:flock, "capistrano_dockerbuild.lock", "-c", "'#{commands}'")
+        else
+          timestamp = Time.now.to_i
+          git_sha1 = `git rev-parse #{fetch(:branch)}`.chomp
+          worktree_dir_name = "worktree-#{git_sha1}-#{timestamp}"
 
-        execute(:git, :worktree, :add, worktree_dir_name, fetch(:branch))
+          execute(:git, :worktree, :add, worktree_dir_name, git_sha1)
 
-        begin
-          within worktree_dir_name do
-            execute(*fetch(:docker_build_cmd))
+          begin
+            within worktree_dir_name do
+              execute(*fetch(:docker_build_cmd))
+            end
+          ensure
+            execute(:rm, "-rf", worktree_dir_name)
+            execute(:git, :worktree, :prune)
+            # Execute "git gc" manually to avoid "There are too many unreachable loose objects" warning
+            execute(:git, :gc, "--auto", "--prune=#{fetch(:git_gc_prune_date)}")
           end
-        ensure
-          execute(:rm, "-rf", worktree_dir_name)
-          execute(:git, :worktree, :prune)
-          # Execute "git gc" manually to avoid "There are too many unreachable loose objects" warning
-          execute(:git, :gc, "--auto", "--prune=3.days.ago")
         end
       end
     end
@@ -58,6 +75,11 @@ namespace :docker do
     on fetch(:docker_build_server_host) do
       execute(:docker, :tag, fetch(:docker_tag_full), fetch(:docker_remote_tag_full))
       execute(:docker, :push, fetch(:docker_remote_tag_full))
+      if fetch(:docker_latest_tag)
+        latest_tag = "#{fetch(:docker_registry) &.+ "/"}#{fetch(:docker_remote_repository_name)}:latest"
+        execute(:docker, :tag, fetch(:docker_tag_full), latest_tag)
+        execute(:docker, :push, latest_tag)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-dockerbuild
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - joker1007
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: Capistrano task definition for `docker build`
 email:
 - kakyoin.hierophant@gmail.com
@@ -73,7 +73,7 @@ homepage: https://github.com/reproio/capistrano-dockerbuild
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Capistrano task definition for `docker build`
 test_files: []