shiplane 0.2.7 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5ceb3e3ec92da5d153b204c2f3d8e8d9108bc354c2690f6d9de39b69ee1893
-  data.tar.gz: f4e5b7340fa59249d4a3ffdfc2ce0f612a6c3faaf49208feebfb12fa0853f099
+  metadata.gz: a5bade01c9a02846ef6c34f6a66d5c303c2ab83dda7a50ac5793bb40bad600e2
+  data.tar.gz: 159d3cb160e84f1fc0876b68b2e8ac2590c6c068dcc527dd100a368f4b20b52d
 SHA512:
-  metadata.gz: 74ce1231080dca4313fa9ed5c37c3197c2fd7e3d05ce275c13e1c0a4aac0a1a8c1f4d0a224b423141cdfc5633c57ad490c46834a8045395948ff9f082ff351dd
-  data.tar.gz: f627396ec65b1f5cba4215567d7b0559b91501e5336a3d03a560877d589b0eb452b8380bac1602931be97c7f98c978c53d2fe7713eb080b7600f558429ce6f87
+  metadata.gz: b226b6449b15e3d3d38b9c505969d87fedee62588ae7f2dc1e18555a6fa83f602241915e9d95a13a3d859ede4434238c912f7ecfe72733e309d05ede4826c4cc
+  data.tar.gz: 195bb3504c830b9dd4d28a122ab8c1b599a174162b15e61a44a2a1c53884a6f0815ce010302bf531b04633d4972551502e25d6e4ca41f2fff6c6eb3d03d53bf7

data/README.md

@@ -118,6 +118,33 @@ You can build a docker container based on the HEAD of your current branch like s
 bundle exec cap production shiplane
 ```
 
+### Environment Variables
+Shiplane uses specific .env files to make sure that a given build environment contains the appropriate environment variables. These are used for 3 separate purposes:
+- The environment that the Shiplane process is running in. For example, if you want to authenticate with a Github private repo, you will need to set the GITHUB_TOKEN environment variable in your .env file so that Shiplane can authenticate.
+- The buildtime step of building the container. If your container needs environment variables to be set during buildtime so that the container can be built, you will need these builtime env variables. Examples might include a Github Token used to pull dependencies from private repositories on Github during buildtime. These variables will not be stored in your container, but you may need to remove any traces of these variables that might be stored in your container as side effects if your dependency ecosystem does this. For example, Ruby Gems downloaded during buildtime using an Github Token will result in that token being stored in the Gemfile.lock file. The [examples folder](examples/rails_app/.shiplane/production_dockerfile_stages) provide an example of a means of removing this after bundling. You may consider a similar step during your build process.
+- The runtime environment may require some environment variables. For example, you might have a bunch of ENVIRONMENT VARIABLES necessary for your application to run (less secure, but simpler), or, you might need an environment variable to access a vault somewhere containing other runtime ENVIRONMENT VARIABLES (more secure, slightly more difficult), or, you may have none at all and use another mechanism to inject appropriate settings (you have more control over this, but the most difficult).
+
+## Important ENVIRONMENT VARIABLES for the Shiplane Process
+```sh
+GITHUB_TOKEN=XXXXXXXXXX # required if pulling from a private Github Repository
+BITBUCKET_TOKEN=XXXXXXXXXX # required if pulling from a private Bitbucket Repository
+BITBUCKET_USERNAME=XXXXXXXXXX # required if pulling from a private Bitbucket Repository
+```
+
+## Important ENVIRONMENT VARIABLES for buildtime
+```sh
+DOCKERHUB_PASSWORD=XXXXXXXXXX # deprecated but still supported token/password specifically for DOCKERHUB
+DOCKERHUB_USERNAME=XXXXXXXXXX # deprecated but still supported username specifically for DOCKERHUB
+SHIPLANE_CONTAINER_REGISTRY_TOKEN=XXXXXXXXXX # Token for container registry authentication
+SHIPLANE_CONTAINER_REGISTRY_USERNAME=XXXXXXXXXX # Username for container registry authentication
+RAISE_EXCEPTIONS_ON_FAILED_BUILD=true # Tells Shiplane to stop on a failed build and raise an exception. Defaults to 'false'
+```
+## Important ENVIRONMENT VARIABLES for runtime
+# Rails Environment Variable sample
+```sh
+RAILS_MASTER_KEY=XXXXXXXXXX
+```
+
 #### Deploying
 Shiplane provides tasks to help you deploy your code. These tasks depend on your deployment framework, but each task appropriately launches your docker containers on your selected framework.
 

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

@@ -1,17 +1,18 @@
 project:
   appname: <%= app_name %>
   version_control: git
-  # The origin url on Github
-  # origin: username/repo_title
+  version_control_host: github # alternately, use `bitbucket` if your application is hosted on BitBucket
+  # The origin url on Github or Bitbucket
+  origin: #username/<%= app_name %>
 bootstrap:
   env_file: .env.production
   chef-bootstrapper:
-    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
+    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
 build:
   registry:
     # url: ghcr.io # for Github Container Service. Should work for similar services such as Gitlab
-    # url: :dockerhub # for default Dockerhub Service
+    # url: dockerhub # for default Dockerhub Service
   settings_folder: .shiplane
   environment_file: .env.production
   compose_filepath: docker-compose.yml
@@ -20,7 +21,7 @@ build:
   artifacts:
     container-name:
       tag: <%= app_name %>-base:latest
-      repo: kirillian2/<%= app_name %>
+      repo: #username/<%= app_name %>
       ports:
         - "3000:3000"
   compose:
@@ -40,8 +41,8 @@ deploy:
       requires_sudo: false
       # Put SSH options here
       # ssh_options:
-      #   user: a_user
-      #   keys: "path/to/ssh/keys"
+      #   user: <%= ENV['SSH_USERNAME_ENV_VARIABLE_HERE'] %>
+      #   keys: <%= ENV['PATH_TO_SSH_KEYS_HERE'] %>
       #   forward_agent: true
       #   auth_methods:
       #     - publickey

data/lib/shiplane/build.rb

@@ -53,7 +53,7 @@ module Shiplane
       end
     rescue StepFailureException => e
       puts e.message
-      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD'] == 'true'
     end
 
     def steps(artifact_name, attributes)
@@ -147,7 +147,7 @@ module Shiplane
     end
 
     def dockerhub?
-      registry_configuration['url'] == :dockerhub
+      registry_configuration['url'].to_s == 'dockerhub'
     end
 
     def token_auth?

data/lib/shiplane/checkout_artifact.rb

@@ -21,12 +21,37 @@ module Shiplane
       @appname ||= project_config['appname']
     end
 
+    def bitbucket_origin?
+      project_config['version_control_host'] == 'bitbucket'
+    end
+
+    def github_origin?
+      project_config['version_control_host'] == 'github'
+    end
+
     def github_token
       @github_token ||= ENV['GITHUB_TOKEN']
     end
 
+    def bitbucket_token
+      @bitbucket_token ||= ENV['BITBUCKET_APP_PASSWORD']
+    end
+
+    def bitbucket_username
+      @bitbucket_username ||= ENV['BITBUCKET_APP_USERNAME']
+    end
+
     def git_url
-      "https://#{github_token ? "#{github_token}@" : ''}github.com/#{project_config['origin']}"
+      return github_url if github_origin?
+      return bitbucket_url if bitbucket_origin?
+    end
+
+    def github_url
+      "https://#{github_token ? "#{github_token}@" : ''}github.com/#{project_config['origin']}/archive/#{sha}.tar.gz"
+    end
+
+    def bitbucket_url
+      "https://#{bitbucket_token ? "#{bitbucket_username}:#{bitbucket_token}@" : ''}bitbucket.org/#{project_config['origin']}/get/#{sha}.tar.gz"
     end
 
     def app_directory
@@ -67,7 +92,7 @@ module Shiplane
     def download_archive
       return true if File.exist? archive_path
 
-      system("curl -L #{git_url}/archive/#{sha}.tar.gz --output #{archive_path}")
+      system("curl -L #{git_url} --output #{archive_path}")
     end
 
     def unpack_archive

data/lib/shiplane/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.10
 platform: ruby
 authors:
 - John Epperson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2022-05-29 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.7
+        version: 0.2.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.10
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.10
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement