shiplane 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24630dde655efe6157f41b56971d38dae1756785a8986a56b2a29dd159a9ff32
-  data.tar.gz: f1a246d2253e9042b9d63034de457cc48fceec19d818a30aaaca83e605788fe0
+  metadata.gz: 5b5acdecf601b6e3dcc169a7034ba182339401e432a4ede3a718f0fce112f400
+  data.tar.gz: 311b91b9388650ccdf260dca0a92f99c776019e182a05044b31fb352a0a5a51b
 SHA512:
-  metadata.gz: 3e3277e0f480bd4f1762dc1e49e064c856aed3dbae1c94577610b155f27daa400da97294f13006302dcfb116c3be8e458f831177eec53a82967210dde567deeb
-  data.tar.gz: 6f686d80e59aded2d251c17b155624ce1f005c8182426e8c13c34a323f7c12b9d4e253b0dd7a0ddbca1ba3508381ddae9de4c45567d9b0fc22bb083ad1dbc35d
+  metadata.gz: 3fd03c6026a3a18cbcbdf974830f826c4c766712b7859de225a86b50c15e45970e9ac03a531204af708a5e81ffa8e79f3fbe39b8640f7e9443b2b68c19c0a7eb
+  data.tar.gz: dda7a3732b07058709461b24deccf24a9c471381af8667e915344e0ee1dcb9f7ac3b4e969e7e9d93ef1f541eeb064c491858aa104733e7485258f838bc90b926

data/README.md

@@ -131,6 +131,12 @@ You can run a deployment like so:
 bundle exec cap production deploy
 ```
 
+You can also deploy a specific Git SHA using the following syntax:
+
+```sh
+bundle exec cap production deploy[<sha>]
+```
+
 ### Troubleshooting
 This is as much a reminder to me as anyone else. If a new version of the gem has just been released and you are trying to pull it, make sure to run the following if bundler fails:
 ```

data/lib/capistrano/tasks/capistrano_stubs.rake

@@ -12,6 +12,22 @@ namespace :deploy do
   end
 end
 
+Rake::Task["deploy"].clear
+task :deploy, :sha do |t, args|
+  sha = args[:sha] || fetch(:sha) || `git rev-parse HEAD`.chomp
+  set :sha, sha
+
+  set(:deploying, true)
+  %w{ starting started
+      updating updated
+      publishing published
+      finishing finished }.each do |task|
+    invoke "deploy:#{task}"
+  end
+end
+Rake::Task["default"].clear
+task default: :deploy
+
 
 # deploy
 #   deploy:check

data/lib/generators/shiplane/install/templates/deploy.rb.erb

@@ -8,7 +8,7 @@ lock '3.11.0'
 set :application, 'podcaster'
 set :repo_url, 'git@github.com:kirillian/podcaster.git'
 
-set :deploy_to, '/var/www/battlecryforfreedom'
+set :deploy_to, '/var/www/my_app_network'
 
 # Default value for :log_level is :debug
 # set :log_level, :debug
@@ -54,8 +54,21 @@ set :sha, `git rev-parse HEAD`.chomp
 set :shiplane_docker_registry_username, ENV['DOCKERHUB_USERNAME']
 set :shiplane_docker_registry_password, ENV['DOCKERHUB_PASSWORD']
 
+
+set :shiplane_build_environment_variables, {
+  # The following example Fetches RAILS_ENV from your Capistrano environment-specific configuration
+  # RAILS_ENV: proc { fetch(:rails_env, 'production') },
+}
+
+# The following setting points shiplane to Github's Registry
+# set :shiplane_docker_registry_url, 'ghcr.io'
+
+# The following settings assign the username and token/password needed to login to a given registry
+# set :shiplane_docker_registry_username, ENV['SHIPLANE_CONTAINER_REGISTRY_USERNAME']
+# set :shiplane_docker_registry_token, ENV['SHIPLANE_CONTAINER_REGISTRY_TOKEN']
+
 set :shiplane_networks, {
-  battlecryforfreedom: {
+  my_app_network: {
     connections: [
       "nginx_reverse_proxy",
       "nginx-proxy-letsencrypt",
@@ -65,28 +78,28 @@ set :shiplane_networks, {
 
 set :shiplane_containers, {
   app: {
-    alias: 'battlecryforfreedom-app',
+    alias: 'my_app-app',
     volumes: [],
     environment: [],
     expose: 3000,
     capistrano_role: "docker",
-    repo: "kirillian2/podcaster",
+    repo: "my_docker_repo_account_name/my_docker_repo",
     command: 'bin/start',
-    virtual_host: "battlecryforfreedom.com",
-    letsencrypt_email: "john.epperson@battlecryforfreedom.com",
+    virtual_host: "my_app.com",
+    letsencrypt_email: "john.epperson@my_app_network.com",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
   },
   sidekiq: {
-    alias: 'battlecryforfreedom-sidekiq',
+    alias: 'my_app-sidekiq',
     volumes: [],
     environment: [],
     capistrano_role: "docker",
-    repo: "kirillian2/podcaster",
+    repo: "my_docker_repo_account_name/my_docker_repo",
     command: 'bin/start_sidekiq_workers',
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
   },
   redis: {
@@ -101,22 +114,37 @@ set :shiplane_containers, {
     repo: "redis",
     tag: "4.0.9-alpine",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
+    deploy: {
+      # This setting will tell shiplane NOT to restart this container every deploy
+      restart: false,
+    },
   },
   postgres: {
     alias: 'postgres',
     volumes: [
       "/var/lib/postgres/data:/var/lib/postgresql/data",
     ],
+    environment: {
+      POSTGRES_PASSWORD: ENV['DATABASE_PASSWORD'],
+      POSTGRES_USER: ENV['DATABASE_USERNAME'],
+    },
+    flags: {
+      'shm-size' => '256MB',
+    },
     expose: 5432,
     publish: 5432,
     capistrano_role: "docker",
     repo: "postgres",
     tag: "9.6",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
+    deploy: {
+      # This setting will tell shiplane NOT to restart this container every deploy
+      restart: false,
+    },
   },
 }
 

data/lib/generators/shiplane/install/templates/production_dockerfile_stages.erb

@@ -6,6 +6,8 @@ COPY . $APP_PATH
 
 WORKDIR $APP_PATH
 
+ARG RAILS_ENV production
+ENV RAILS_ENV $RAILS_ENV
 ARG GITHUB_TOKEN
 ENV GITHUB_TOKEN $GITHUB_TOKEN
 ENV SHIPLANE building
@@ -36,7 +38,8 @@ WORKDIR $APP_PATH
 RUN bundle config --local path vendor/bundle
 RUN bundle config --local without development:test:assets
 
-ENV RAILS_ENV production
+ARG RAILS_ENV production
+ENV RAILS_ENV $RAILS_ENV
 ENV SHIPLANE running
 ENV RAILS_LOG_TO_STDOUT true
 ENV RAILS_SERVE_STATIC_FILES true

data/lib/generators/shiplane/install/templates/shiplane.yml.erb

@@ -6,8 +6,8 @@ project:
 bootstrap:
   env_file: .env.production
   chef-bootstrapper:
-    package_name: chefdk_3.6.57-1_amd64.deb
-    package_url: https://packages.chef.io/files/stable/chefdk/3.6.57/ubuntu/18.04/chefdk_3.6.57-1_amd64.deb
+    package_name: chefdk_3.13.1-1_amd64.deb
+    package_url: https://packages.chef.io/files/stable/chefdk/3.13.1/ubuntu/16.04/chefdk_3.13.1-1_amd64.deb
 build:
   registry:
     # url: ghcr.io # for Github Container Service. Should work for similar services such as Gitlab
@@ -34,9 +34,9 @@ build:
       - services.container-name.depends_on
 deploy:
   servers:
-    # put the server domain or ip address here
+    # `server-url` is your server domain or ip address here (e.g. `12.345.67.89` or `myapp.com`)
     server-url:
-      # Only set this flag if you need docker to run as the sudo user (default Ubuntu AMI on AWS requires this)
+      # Only set this flag if you need docker to escalate permissions and run everything as sudo (default Ubuntu AMI on AWS requires this)
       requires_sudo: false
       # Put SSH options here
       # ssh_options:

data/lib/shiplane/build.rb

@@ -19,6 +19,16 @@ module Shiplane
       @postfix = postfix
 
       Dotenv.overload File.join(Dir.pwd, build_config.fetch('environment_file', '.env'))
+
+      # Add any ENV variable overrides from the capistrano configuration
+      environment_variable_overrides = fetch(:shiplane_build_environment_variables, {})
+      environment_variable_overrides.each do |key, value|
+        if value.is_a? Proc
+          ENV[key.to_s] = value.call
+        else
+          ENV[key.to_s] = value
+        end
+      end
     end
 
     def build!
@@ -73,7 +83,7 @@ module Shiplane
     def token_login_command
       @token_login_command ||= [
         'echo',
-        login_token,
+        "\"#{login_token}\"",
         '|',
         'docker',
         'login',

data/lib/shiplane/deploy/container_configuration.rb

@@ -44,7 +44,11 @@ module Shiplane
       end
 
       def virtual_host
-        @virtual_host ||= options[:virtual_host]
+        return @virtual_host if defined?(@virtual_host) && @virtual_host
+
+        if options[:virtual_host]
+          @virtual_host = options[:virtual_host].is_a?(Proc) ? options[:virtual_host].call : options[:virtual_host]
+        end
       end
 
       def letsencrypt_host

data/lib/shiplane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiplane
-  VERSION = "0.2.2"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - John Epperson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shiplane_bootstrappers_chef
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement