release_manager 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0056b26bafb18d0a01df0610acfc187b5b894416
-  data.tar.gz: bd8a438f19dbee1ebb1ca73c277eac99b14222c9
+  metadata.gz: d6069b076747b74494e4aaf2d464abd5436d742b
+  data.tar.gz: 277bbc9bb132f094ccf4cdcc7a761741cd92eaef
 SHA512:
-  metadata.gz: 548c678ef78f0a13b3d2c9c6e40e1b97b12a64590cb5eb5c71595d3547e711e8bdbe98d7d88ddd3e61d305d0fb7d9715056fb47c9b923c392c12ef5ebcb1e5f1
-  data.tar.gz: fd8faf85ad2d821365a10d122c70683a4575db9769aaf9b54c765e07a8c59865229581c9863ba47a5a22f89d5bb8abcdddcb71b6f42b58014b17646970cf8f66
+  metadata.gz: 892cde4d6302725ada12b0b1e89f2854d61fac8d375492b1916a5d5d8e5cce99c6871107a2f8cac1bdd1a5cf2b51427297fdd7c0501448d7e6530ac9bd72ce46
+  data.tar.gz: 1fbc83551bdb199c07ea26835e98e0d9ddff4195de16ff5845419dff6f665b4024dd2518dc74322cd8ae381e7941b00372de578ae18c66687f9f60a3938b0486

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Release Manager
 
-## Unreleased
+## 0.8.0
+ * Allows for creating sandboxes from different targets
+ * Allow for releasing one off patches with release-mod
+ * Fixes #11 - release-mod should show which variables to set
+## 0.7.0
  * Fixes #3 - release-mod fails when trying to sort tags
  * Fixes #8 - files disappear from change set
  * Fixes #1 - deploy-mod creates commit everytime

data/Gemfile

@@ -1,6 +1,6 @@
 source ENV['GEM_SOURCE'] ||'https://rubygems.org'
 # Specify your gem's dependencies in release_manager.gemspec
-gem 'gitlab', '~> 4.2.0'
+gem 'gitlab'
 gem 'rugged', '~> 0.26'
 gem 'highline', '~> 1.7'
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    release_manager (0.7.0)
+    release_manager (0.8.0)
       gitlab (~> 4.2.0)
       highline (~> 1.7)
       rugged (~> 0.26)
@@ -21,15 +21,15 @@ GEM
     method_source (0.9.0)
     multi_xml (0.6.0)
     parallel (1.12.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     powerpack (0.1.1)
     pry (0.11.1)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (2.2.2)
       rake
-    rake (12.1.0)
+    rake (12.3.0)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -43,14 +43,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
-    rubocop (0.50.0)
+    rubocop (0.51.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.3)
+    ruby-progressbar (1.9.0)
     rugged (0.26.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
@@ -61,7 +61,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  gitlab (~> 4.2.0)
+  gitlab
   highline (~> 1.7)
   pry
   rake

data/README.md

@@ -16,18 +16,27 @@ __________       .__                                   _____
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
     - [Install directly from source](#install-directly-from-source)
+  - [Usage Summary](#usage-summary)
   - [The workflow problem](#the-workflow-problem)
     - [R10k Sandbox Creation Steps (the hard way)](#r10k-sandbox-creation-steps-the-hard-way)
     - [R10k Sandbox Creation steps (the easy way)](#r10k-sandbox-creation-steps-the-easy-way)
-  - [Usage](#usage)
+  - [Detailed Usage](#detailed-usage)
     - [sandbox-create](#sandbox-create)
     - [release-mod](#release-mod)
     - [deploy-mod](#deploy-mod)
     - [bump-changelog](#bump-changelog)
+  - [Common Workflows](#common-workflows)
+    - [Creating releases](#creating-releases)
+    - [Creating one off releases](#creating-one-off-releases)
   - [Configuration Settings](#configuration-settings)
     - [Sandbox-create environment variables](#sandbox-create-environment-variables)
   - [Ssh agent usage](#ssh-agent-usage)
   - [Development](#development)
+  - [Develpment Environment Setup](#develpment-environment-setup)
+    - [Setting up your Gitlab Instance](#setting-up-your-gitlab-instance)
+    - [Configure your release manager client](#configure-your-release-manager-client)
+    - [Testing the cli commands](#testing-the-cli-commands)
+    - [Debugging](#debugging)
   - [Contributing](#contributing)
   - [License](#license)
 
@@ -48,6 +57,8 @@ This gem provides workflow automations around releasing and deploying puppet mod
 7. Must have a Gitlab API Access token (per user)
 8. Must have the libssh-dev library package installed
 9. Must tag code with version tags ie. `v1.2.3`
+10. Must keep a CHANGELOG.md
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -73,6 +84,15 @@ gem install specific_install  # unless already installed
 gem specific_install https://github.com/nwops/release_manager  
 ```
 
+## Usage Summary
+There are several cli utilities bundled with the gem, each one can be used independently of the other.  Detailed usage can be
+found further below in this document.
+
+* `sandbox-create -n my_sandbox`  - Sandbox creation and module repo forking (most popular)
+* `deploy-mod`  - Sandbox creation and repo forking
+* `deploy-r10k` - Deploying your r10k repo to other branches in the same repo using merge requests
+* `release-mod`  - Sandbox creation and repo forking  (Also popular)
+* `bump-changelog` - for directly manipulating the changelog
 
 ## The workflow problem
 R10k allows us to create a puppet environment for each branch on the r10k-control repository. This makes isolating code deployments
@@ -98,7 +118,7 @@ to use those new branches and forks.  This can be a huge burden and consume some
 15. push new branch on each forked project
 
 Yikes!  This is a long list of things to do.  It is human nature to skip some or all of these steps to save time even though
-it is in our best interest to follow these steps.  As humans we will always resort to the path of least resistance. 
+it is in our best interest to follow these steps.  Most humans we will always resort to the path of least resistance. 
 
 In an effort to force good practices and reduce time and effort, release-manager will automate almost all of the tasks into 
 a single command called `sandbox-create`.
@@ -108,7 +128,7 @@ Additionally there are other commands that help with the release and deploy proc
 ### R10k Sandbox Creation steps (the easy way)
 `sandbox-create -n my_sandbox --modules='roles,profiles,hieradata,sqlserver'`  
 
-## Usage
+## Detailed Usage
 
 Release manager provides the following commands to help you create sandboxes, release and deploy puppet code.
 
@@ -127,22 +147,48 @@ Summary: Creates a new r10k sandbox by forking and creating a new branch on r10k
          for each module, updates the r10k-control Puppetfile to use those forks and branches
          and pushes the branch to the upstream r10k-control.
 
-Example: sandbox-create -n my_sandbox -m "roles,profiles,developer"
-Example: sandbox-create -n my_sandbox -m "roles,profiles,developer" --members="p1dksk2, p2ksdafs,devops,ci_runner" 
-
 
 Note: If you already have any of these modules cloned, this script will attempt to update those modules
       using git fetch and git checkout -b sandbox_name upstream/master.  So this should not destroy anything.
 
+Configuration:
+
+This script uses the following environment variables to automatically set some options, please ensure 
+they exist in your shell environment.  You can set an environment variable in the shell or define 
+in your shell startup files.
+
+Shell:  export VARIABLE_NAME=value
+
+R10K_REPO_URL            - The git repo url to r10k-control (ie. git@gitlab.com:devops/r10k-control.git)
+GITLAB_API_ENDPOINT      - The api path to the gitlab server  (ie. https://gitlab_server/api/v3)
+                           replace gitlab_server with your server hostname
+GITLAB_API_PRIVATE_TOKEN - The gitlab user api token.  
+                           You can get a token here (http://web/profile/personal_access_tokens, 
+                           Ensure api box is checked.
+DEFAULT_MODULES          - The default set of modules to fork use when 
+                           a sandbox (ie. export DEFAULT_MODULES='hieradata, roles')
+
+DEFAULT_MEMBERS          - The default members each forked project should add permissions
+                           to ( ie, DEFAULT_MEMBERS='ci_runner,r10k_user' )
+
+If your gitlab server has a invalid certificate you can set the following variable to "fix" that trust issue.
+export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
+
+Examples:
+  sandbox-create -n my_sandbox -m "roles,profiles,developer" 
+  sandbox-create -n my_sandbox -m "roles,profiles,developer" --members="p1dksk2,devops,ci_runner"
+  sandbox-create -n my_sandbox -s "upstream/v0.5.0" 
+
+Options:
         --members DEFAULT_MEMBERS    A comman seperated list of members to add to forked projects
     -n, --name NAME                  The name of your sandbox
+    -s, --src-target REMOTE/REF      The source of the target to create your sandbox from, defaults to upstream/dev
         --control-url R10K_REPO_URL  git url to the r10k-control repo, defaults to R10K_CONTROL_URL env variable
     -m, --modules MODULES            A comma separated list of modules names from the Puppetfile to fork and branch
     -r, --repos-dir [REPOS_PATH]     The repos path to clone modules to. Defaults to: /home/appuser/repos
     -c, --control-dir [CONTROL_DIR]  The r10k-control repo path. Defaults to: /home/appuser/repos/r10k-control
         --verbose                    Extra logging
 
-
 ```
 
 Example Run
@@ -243,6 +289,31 @@ and creates a new 'Unrelease Section on top
 
 If using the `release-mod` command there is no need to run the `bump-changelog`command as it is part of the process already.
 
+## Common Workflows
+### Creating releases
+You worked hard on your code and now you want to release your software for others to enjoy.
+Follow the steps below to version your code before deployment.  This these changes are considered major
+we want to create a 2.0.0 release.
+
+1. run `release-mod -l major` from the root of the module directory (use `-d` for a dry run)
+
+That's it, all you need to do is run that command.  Note, by design you are not allowed to enter a version number.  Release Manager
+uses the version in metadata.json file as a reference and increments to semver identifiers. 
+
+
+### Creating one off releases
+
+1. Did you deploy a release all the way to production only to find a bug?
+2. Do you want to skip all other deployment stages with your patch?
+
+Follow the steps below to create a new patch release and deploy straight to production
+
+1. Create a new sandbox based on the branch or tag you want to fix. `sandbox-create -s v0.5.0 -n patch_0.5.1`
+2. cd ~/repos/r10k-control
+3. Make your changes in that branch and update the changelog
+4. Push your code to the remote Git repo and activate your CI pipeline (optional)
+5. Release the new version `release-mod -l patch -s patch_0.5.1`  (creates tag v0.5.1)
+6. Deploy the patch release to production `deploy-r10k -s v0.5.1 -d production`
 
 ## Configuration Settings
 The following environment variables will automatically set required parameters and defaults.  It is suggested you put 
@@ -322,8 +393,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 5. Login (root/password123)
 6. Create a user account for yourself (add Admin role)
 7. Logout as Admin and login as the new user account
-8. Add a group named devops and add yourself to this group
-9. Add another group called mirrors and add yourself to this group
 10. Create a `.env` file in the repo directory and paste these contents in it
   ```ruby
 GITLAB_API_ENDPOINT='http://web/api/v4'

data/lib/release_manager.rb

@@ -28,6 +28,13 @@ class String
   end
 end
 module ReleaseManager
-
+  def self.gitlab_server
+    if ENV['GITLAB_API_ENDPOINT']
+      if data = ENV['GITLAB_API_ENDPOINT'].match(/(https?\:\/\/[\w\.]+)/)
+        return data[1]
+      end
+    end
+    'https://gitlab.com'
+  end
 end
 

data/lib/release_manager/cli/deploy_mod_cli.rb

@@ -15,6 +15,7 @@ module ReleaseManager
              tag version. Revmoes any branch or ref reference and replaces
              with tag.  Currently it is up to you to commit and push the Puppetfile change.
 
+Options:
         EOF
         )
         opts.on('-p', "--puppetfile [PUPPETFILE]", 'Path to R10k Puppetfile, defaults to ~/repos/r10k-control/Puppetfile') do |p|

data/lib/release_manager/cli/deploy_r10k_cli.rb

@@ -35,11 +35,11 @@ Summary: Deploys the source ref into the dest branch by diffing the two and appl
    6. push branch and create merge request
 
    Examples:
-      deploy-r10k dev qa
       deploy-r10k -s dev -d qa
       deploy-r10k -p ~/repos/r10k-control -s dev -d qa
+      deploy-r10k -s v0.5.1 -d production
 
-
+Options:
         EOF
         )
         opts.on('-p', "--puppetfile [PUPPETFILE]", "Path to R10k Puppetfile, defaults to #{puppetfile_path}") do |p|

data/lib/release_manager/cli/release_mod_cli.rb

@@ -30,6 +30,28 @@ Summary: Bumps the module version to the next revision and
          version by reading the metadata.json file. This should
          be run inside a module directory.
 
+ Examples:
+      release-mod -l minor
+      release-mod -l patch -s patch1
+      release-mod -m ~/repos/r10k-control
+      
+
+Configuration:
+
+This script uses the following environment variables to automatically set some options, please ensure 
+they exist in your shell environment.  You can set an environment variable in the shell or define 
+in your shell startup files.
+
+Shell:  export VARIABLE_NAME=value
+
+R10K_REPO_URL            - The git repo url to r10k-control (ie. git@gitlab.com:devops/r10k-control.git)
+GITLAB_API_ENDPOINT      - The api path to the gitlab server  (ie. https://gitlab_server/api/v4)
+                           replace gitlab_server with your server hostname
+GITLAB_API_PRIVATE_TOKEN - The gitlab user api token.  
+                           You can get a token here (#{ReleaseManager.gitlab_server}/profile/personal_access_tokens), 
+                           Ensure api box is checked.
+
+Options:
         EOF
         )
         opts.on("-d", "--dry-run", "Do a dry run, without making changes") do |c|
@@ -53,11 +75,26 @@ Summary: Bumps the module version to the next revision and
         opts.on('--verbose', "Extra logging") do |c|
           options[:verbose] = c
         end
+        opts.on('-s', '--src-branch [BRANCH]', 'The branch you want to base the release from, defaults to dev or master') do |c|
+          options[:src_branch] = c
+        end
         opts.on('-r', '--remote-release', "Perform a remote release (For CI systems)") do |c|
           options[:remote] = true
         end
       end.parse!
 
+      unless ENV['GITLAB_API_ENDPOINT']
+        puts "Please set the GITLAB_API_ENDPOINT environment variable".fatal
+        puts "Example: export GITLAB_API_ENDPOINT=https://gitlab.com/api/v4".fatal
+        exit 1
+      end
+
+      unless ENV['GITLAB_API_PRIVATE_TOKEN']
+        puts "Please set the GITLAB_API_PRIVATE_TOKEN environment variable".fatal
+        puts "Example: export GITLAB_API_PRIVATE_TOKEN=kdii2ljljijsldjfoa".fatal
+        exit 1
+      end
+
       # default to patch
       options[:level] ||= 'patch'
 

data/lib/release_manager/cli/sandbox_create_cli.rb

@@ -4,12 +4,7 @@ module ReleaseManager
   class SandboxCreateCli
 
     def self.gitlab_server
-      if ENV['GITLAB_API_ENDPOINT']
-        if data = ENV['GITLAB_API_ENDPOINT'].match(/(https?\:\/\/[\w\.]+)/)
-          return data[1]
-        end
-      end
-      'https://gitlab.com'
+     ReleaseManager.gitlab_server
     end
 
     def self.run
@@ -37,7 +32,7 @@ in your shell startup files.
 Shell:  export VARIABLE_NAME=value
 
 R10K_REPO_URL            - The git repo url to r10k-control (ie. git@gitlab.com:devops/r10k-control.git)
-GITLAB_API_ENDPOINT      - The api path to the gitlab server  (ie. https://gitlab_server/api/v3)
+GITLAB_API_ENDPOINT      - The api path to the gitlab server  (ie. https://gitlab_server/api/v4)
                            replace gitlab_server with your server hostname
 GITLAB_API_PRIVATE_TOKEN - The gitlab user api token.  
                            You can get a token here (#{gitlab_server}/profile/personal_access_tokens, 
@@ -54,6 +49,7 @@ export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
 Examples:
   #{opts.program_name} -n my_sandbox -m "roles,profiles,developer" 
   #{opts.program_name} -n my_sandbox -m "roles,profiles,developer" --members="p1dksk2,devops,ci_runner"
+  #{opts.program_name} -n my_sandbox -s "upstream/v0.5.0" 
 
 Options:
         EOF
@@ -64,6 +60,9 @@ Options:
         opts.on('-n', "--name NAME", "The name of your sandbox") do |n|
           options[:sandbox_name] = n
         end
+        opts.on('-s', "--src-target REMOTE/REF", "The source of the target to create your sandbox from, defaults to upstream/dev") do |n|
+          options[:src_target] = n
+        end
         opts.on('--control-url R10K_REPO_URL', "git url to the r10k-control repo, defaults to R10K_CONTROL_URL env variable") do |r|
           options[:r10k_repo_url] = r
         end
@@ -84,7 +83,7 @@ Options:
       end.parse!
       unless ENV['GITLAB_API_ENDPOINT']
         puts "Please set the GITLAB_API_ENDPOINT environment variable".fatal
-        puts "Example: export GITLAB_API_ENDPOINT=https://gitlab.com/api/v3".fatal
+        puts "Example: export GITLAB_API_ENDPOINT=https://gitlab.com/api/v4".fatal
         exit 1
       end
 
@@ -101,6 +100,11 @@ Options:
       options[:repos_path] ||= File.expand_path(File.join(ENV['HOME'], 'repos'))
       options[:r10k_repo_url] ||= ENV['R10K_REPO_URL']
 
+      options[:src_target] ||= 'upstream/dev'
+      if options[:src_target].split("/").count < 2
+        puts "Please use a source target that conforms to the remote/ref pattern".fatal
+        exit 1
+      end
       unless options[:r10k_repo_url]
         puts "Please set the R10K_REPO_URL environment variable or use the --control-url option".fatal
         puts "Example: export R10K_REPO_URL='git@gitlab.com:devops/r10k-control.git'".fatal

data/lib/release_manager/git/utilites.rb

@@ -11,12 +11,14 @@ module ReleaseManager
       end
 
       # @param [String] remote_name - the name of the remote
-      def fetch(remote_name = 'upstream')
+      def fetch(remote_name = 'upstream', tags = false)
+        remote_name ||= 'upstream'
         return unless remote_exists?(remote_name)
         remote = repo.remotes[remote_name]
         options = {credentials: credentials.call(remote.url)}
         logger.info("Fetching remote #{remote_name} from #{remote.url}")
         options[:certificate_check] = lambda { |valid, host| true } if ENV['GIT_SSL_NO_VERIFY']
+        fetch_cli(remote_name) # helps get tags
         remote.fetch(options)
       end
 
@@ -57,7 +59,7 @@ module ReleaseManager
       # @param [Boolean] reset_url - set to true if you wish to reset the remote url
       # @return [Rugged::Remote] a rugged remote object
       def add_remote(url, remote_name = 'upstream', reset_url = false )
-        return unless git_url?(url)
+        return false unless git_url?(url)
         if remote_exists?(remote_name)
           # ensure the correct url is set
           # this sets a non persistant fetch url
@@ -87,10 +89,19 @@ module ReleaseManager
         repo.remotes[name].url.eql?(url)
       end
 
-      # @param [String] name - the name of the branch
+      # @param name [String] - the name of the branch
       # @return [Boolean] - true if the branch exist
       def branch_exist?(name)
-        repo.branches.exist?(name)
+        # ensure we have the latest branches
+        remote_name, ref = name.split('/', 2)
+        if name.include?('/')
+          remote_name, ref = name.split('/', 2)
+        else
+          ref = name
+        end
+        # check to see if we just needed to fetch the upstreams
+        fetch(remote_name) unless (repo.branches.exist?(name) || ref_exists?(name) || tag_exists?(ref))
+        repo.branches.exist?(name) || ref_exists?(name) || tag_exists?(ref)
       end
 
       # we should be creating the branch from upstream
@@ -98,9 +109,11 @@ module ReleaseManager
       def create_branch(name, target = 'upstream/master')
         # fetch the remote if defined in the target
         unless branch_exist?(name)
-          fetch(target.split('/').first) if target.include?('/')
-          logger.info("Creating branch: #{name} for #{path}")
-          repo.create_branch(name, target)
+          remote_name, ref = target.split('/', 2)
+          fetch(remote_name)
+          logger.info("Creating branch: #{name} for #{path} from #{target}")
+          found_ref = find_ref(target)
+          repo.create_branch(name, found_ref)
         else
           repo.branches[name]
         end
@@ -124,6 +137,17 @@ module ReleaseManager
         remote.push(refs, credentials: credentials)
       end
 
+      # @return [Array] - returns an array of tag names
+      def tags
+        repo.tags.map(&:name)
+      end
+
+      # @param name [String] - the name of the tag to check for existence
+      # @return [Boolean] - return true if the tag exists
+      def tag_exists?(name)
+       tags.include?(name)
+      end
+
       # push all the tags to the remote
       # @param [String] remote_name - the remote name to push tags to
       def push_tags(remote_name)
@@ -239,6 +263,12 @@ module ReleaseManager
         raise PatchError.new(output) unless $?.success?
       end
 
+      # @param [String] - the name of the remote to fetch from
+      # @note this is a hack to get around libgit2 inability to get remote tags
+      def fetch_cli(remote)
+        `#{git_command} fetch #{remote} 2>&1 > /dev/null`
+      end
+
       # [Rugged::Diff] a rugged diff object
       # Not fully tested
       def apply_diff(diff)
@@ -385,6 +415,16 @@ module ReleaseManager
         dst.diff(src)
       end
 
+      # @param sha_or_ref [String] - the name or sha of the ref
+      # @return [Boolean] true if the ref exists
+      def ref_exists?(sha1_or_ref)
+        begin
+          find_ref(sha1_or_ref)
+        rescue Rugged::ReferenceError => e
+          false
+        end
+      end
+
       # @param sha_or_ref [String] - the name or sha of the ref
       # @return [String] the oid of the sha or ref
       def find_ref(sha_or_ref)
@@ -392,7 +432,12 @@ module ReleaseManager
           when Rugged::Object
             sha_or_ref.oid
           else
-            repo.rev_parse_oid(sha_or_ref)
+            begin
+              repo.rev_parse_oid(sha_or_ref)
+            rescue Rugged::ReferenceError => e
+              tag = repo.tags.find{|t| t.name == sha_or_ref.split('/').last}
+              repo.rev_parse_oid(tag.target.oid) if tag
+            end
         end
       end
     end

data/lib/release_manager/puppet_module.rb

@@ -6,17 +6,22 @@ require 'release_manager/git/utilites'
 require 'rugged'
 
 class PuppetModule < WorkflowAction
- attr_reader :name, :metadata_file, :path, :version, :upstream
+ attr_reader :name, :metadata_file, :path, :version, :upstream, :options
  attr_writer :version, :source
 
  include ReleaseManager::Git::Utilities
  include ReleaseManager::Logger
  include ReleaseManager::VCSManager
 
- def initialize(mod_path, upstream = nil)
+ # @param mod_path [String] - the path to the module
+ # @param options [Hash] - a hash of options
+ # @option upstream [String] - the upstream url
+ # @option src_branch [String] - the source of the branch
+ def initialize(mod_path, options = {})
    raise ModNotFoundException.new("#{mod_path} is not a valid puppet module path") if mod_path.nil?
    @path = mod_path
-   @upstream = upstream
+   @options = options
+   @upstream = options[:upstream]
    @metadata_file = File.join(mod_path, 'metadata.json')
  end
 
@@ -165,6 +170,7 @@ class PuppetModule < WorkflowAction
    JSON.pretty_generate(metadata)
  end
 
+ # @return [Boolean] - true if the module is an r10k-control repository
  def r10k_module?
    mod_name =~ /r10k[-_]?control/i
  end
@@ -173,21 +179,31 @@ class PuppetModule < WorkflowAction
    @upstream ||= git_upstream_url
  end
 
- # ensures the dev branch has been created and is up to date
- def create_dev_branch
+ # @param branch [String] -  the name of the source branch to create and rebase from
+ # creates a branch and checkouts out the branch with the latest source of the upstream source
+ def create_src_branch(branch = src_branch)
    fetch('upstream')
-   create_branch(src_branch, "upstream/#{src_branch}")
+   create_branch(branch, "upstream/#{branch}")
    # ensure we have updated our local branch
-   checkout_branch(src_branch)
-   rebase_branch(src_branch, src_branch, 'upstream')
+   checkout_branch(branch)
+   rebase_branch(branch, branch, 'upstream')
+ end
+
+ # ensures the dev branch has been created and is up to date
+ # @deprecated Use {#create_src_branch} instead of this method which defaults to dev or master branch
+ def create_dev_branch
+   create_src_branch(src_branch)
  end
 
  # @returns [String] - the source branch to push to
- # if r10k-control this branch will be dev, otherwise master
+ # if the user supplied the src_branch we use that otherwise
+ # if the module is r10k-control this branch will be dev,
+ # if the module is not r10k-control we use master
  def src_branch
-   r10k_module? ? 'dev' : 'master'
+   options[:src_branch] || (r10k_module? ? 'dev' : 'master')
  end
 
+ # pushes the source and tags
  def push_to_upstream
    push_branch(source, src_branch)
    push_tags(source)
@@ -230,6 +246,9 @@ class PuppetModule < WorkflowAction
    end
  end
 
+ # @param tag [String] - the name of the tag
+ # @param remote [String] - check the remote for the tag, defaults to false
+ # @return [Boolean] - returns true if the tag exists
  def tag_exists?(tag, remote = false)
    if remote
      remote_tag_exists?(source, tag)
@@ -238,14 +257,18 @@ class PuppetModule < WorkflowAction
    end
  end
 
+ # creates a file with the puppet metadata.json content written to disk
  def to_metadata_file
    logger.info("Writing to file #{metadata_file}")
    File.write(metadata_file, to_s)
  end
 
  # @return [ControlRepo] - creates a new control repo object and clones the url unless already cloned
+ # @param url [String] - the upstream url
+ # @param branch [String] -  the source branch
  def self.create(path, url, branch = 'master')
-   c = PuppetModule.new(path, url)
+   options = {upstream: url, src_branch: branch}
+   c = PuppetModule.new(path, options)
    c.clone(url, path)
    c
  end

data/lib/release_manager/release.rb

@@ -11,9 +11,11 @@ class Release
   end
 
   def puppet_module
-    @puppet_module ||= PuppetModule.new(path, upstream_repo)
+    @puppet_module ||= PuppetModule.new(path, {upstream: upstream_repo,
+                                               src_branch: options[:src_branch]})
   end
 
+  # @return [String] - the url of the repository defined in the options or environment variable
   def upstream_repo
     options[:repo] || ENV['UPSTREAM_REPO']
   end
@@ -156,7 +158,7 @@ class Release
   def run
     begin
       exit -1 unless check_requirements
-      puppet_module.create_dev_branch
+      puppet_module.create_src_branch
       value = release
       unless value
 	      exit 1

data/lib/release_manager/sandbox.rb

@@ -47,8 +47,10 @@ class Sandbox
   end
 
   # @return [ControlRepo] - creates a new control repo object and clones the url unless already cloned
-  # @param [String] url - the url to clone and fork
-  def setup_control_repo(url)
+  # @param url [String] - the url to clone and fork
+  # @param src_target [String] -  the source to checkout from, defaults to 'upstream/dev'
+  def setup_control_repo(url, src_target = 'upstream/dev')
+    src_target ||= 'upstream/dev'
     # clone r10k unless already cloned
     puts "## r10k-control ##".yellow
     fork = create_repo_fork(url)
@@ -57,9 +59,10 @@ class Sandbox
     c.fetch('myfork')
     c.fetch('origin')
     c.add_remote(url, 'upstream')
+    raise InvalidBranchName.new("The source #{src_target} does not exist") unless c.branch_exist?(src_target)
     # if the user doesn't have the branch, we create from upstream
     # and then checkout from the fork, we defer pushing the branch to later after updating the puppetfile
-    target = c.branch_exist?("upstream/#{name}") ? "upstream/#{name}" : 'upstream/dev'
+    target = c.branch_exist?("upstream/#{name}") ? "upstream/#{name}" : src_target
     # if the user has previously created the branch but doesn't exist locally, no need to create
     c.create_branch(name, target)
     c.checkout_branch(name)
@@ -135,9 +138,15 @@ class Sandbox
   # set upstream to original namespace
   # cleanup branches
   def create(r10k_url)
-    setup_repos_dir(repos_dir)
-    @control_repo = setup_control_repo(r10k_url)
+    begin
+      setup_repos_dir(repos_dir)
+      @control_repo = setup_control_repo(r10k_url, options[:src_target])
     # get modules we are interested in
+    rescue InvalidBranchName => e
+      logger.error(e.message)
+      exit 1
+    end
+
     module_names.each do | mod_name |
       puts "## #{mod_name} ##".yellow
       begin
@@ -209,6 +218,7 @@ class Sandbox
   # if the user does not pass in the git url we assume the repo already exist
   # if the repo doesn't exist we clone the url
   def self.create(name, options)
+
     box = Sandbox.new(name, options[:modules],
                       options[:r10k_repo_path],
                       options[:repos_path], options)

data/lib/release_manager/version.rb

@@ -1,3 +1,3 @@
 module ReleaseManager
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release_manager
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab