modulesync 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba3647204bfcc8853cafeddbf1e4f1083ceaade7fb1806bd06b36e37d6d593e
-  data.tar.gz: ce4305980ed768ffd80580c4618c7d921e0c7c6e17b57edc3dae0c10eacbeef6
+  metadata.gz: cf47637269ebb272e17ffe11db44344aff0677e8a93fec636d7fcf6ed4d66e01
+  data.tar.gz: c2496e33b76a8af894707b6615662f05bcdb4ff73378020238a633b88915f433
 SHA512:
-  metadata.gz: 0cfda65f2a020913fa4cd928e22daac9e5c141f7881afaed928b28af846fe86466fff64314e89b04b9d3cb32bf8e4387ec0410e7142215ac5e0412b15c845d62
-  data.tar.gz: 083fdbb949ce978be0958f3ac2baa8390d38d7221c846b934b5b2e3e49cc60992d662b0afd8322d4efeb3bbec9643faf73b7cba95ba3f91d388953365837494a
+  metadata.gz: b9bc5072c017bff505be1f43e4e0bc2630645d0acee00bbb0a8a2d5b23804e4150414c904126570a5418e310ae873073ce207f91887e8f849db5f9cdc61fd680
+  data.tar.gz: 45588886c292dd533923614af9ea94d74685743a7b7708b3caeb4cbfbfe0539adafa2f78a8183d0d2384a4cd9d8f0c03535935b99c8278031f487317d36370e3

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## 2018-02-15
+## 2018-12-27 - 0.10.0
+
+This is another awesome release!
+
+* Add support to submit PRs to GitHub when changes are pushed - [#147](https://github.com/voxpupuli/modulesync/pull/147)
+* Fix "flat files" still mentioned in README - [#151](https://github.com/voxpupuli/modulesync/pull/151)
+
+## 2018-02-15 - 0.9.0
 
 ## Summary
 

data/Gemfile

@@ -3,3 +3,4 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '< 3.0' if RUBY_VERSION < '2.1'
+gem 'octokit', '~> 4.0'

data/README.md

@@ -176,6 +176,28 @@ touching the modules, you can deactivate the hook.
 msync hook deactivate
 ```
 
+#### Submitting PRs to GitHub
+
+You can have modulesync submit Pull Requests on GitHub automatically with the
+`--pr` CLI option.
+
+```
+msync update --pr
+```
+
+You must set `GITHUB_TOKEN` in your environment for this to work. Other options
+include:
+
+* Set the PR title with `--pr-title` or in `modulesync.yml` with the `pr_title`
+  attribute.
+* Assign labels to the PR with `--pr-labels` or in `modulesync.yml` with the
+  `pr_labels` attribute. **NOTE:** `pr_labels` should be a list. When using
+  the `--pr-labels` CLI option, you should use a comma separated list.
+
+You can optionally set the `GITHUB_BASE_URL` environment variable to use GitHub
+Enterprise. This is passed to Octokit's [`api_endpoint`](https://github.com/octokit/octokit.rb#interacting-with-the-githubcom-apis-in-github-enterprise) 
+configuration option.
+
 ### Using Forks and Non-master branches
 
 The default functionality is to run ModuleSync on the puppetlabs modules, but
@@ -215,7 +237,7 @@ probably seems excessive. You can create a file called modulesync.yml in the
 configuration directory that provides these arguments automatically. This file
 has a form such as:
 
-```
+```yaml
 ---
 namespace: mygithubusername
 branch: modulesyncbranch
@@ -230,26 +252,33 @@ msync update -m "Commit message"
 
 Available parameters for modulesync.yml
 
-* git_base : The default URL to git clone from (Default: 'git@github.com:')
-* namespace : Namespace of the projects to manage (Default: 'puppetlabs')
-* branch : Branch to push to (Default: 'master')
-* remote_branch : Remote branch to push to (Default: Same value as branch)
-* message : Commit message to apply to updated modules.
-* pre_commit_script : A script to be run before commiting (e.g. 'contrib/myfooscript.sh')
+* `git_base` : The default URL to git clone from (Default: 'git@github.com:')
+* `namespace` : Namespace of the projects to manage (Default: 'puppetlabs')
+* `branch` : Branch to push to (Default: 'master')
+* `remote_branch` : Remote branch to push to (Default: Same value as branch)
+* `message` : Commit message to apply to updated modules.
+* `pre_commit_script` : A script to be run before commiting (e.g. 'contrib/myfooscript.sh')
+* `pr_title` : The title to use when submitting PRs to GitHub.
+* `pr_labels` : A list of labels to assign PRs created on GitHub.
 
 ##### Example
 
-###### Github
+###### GitHub
 
-```
+```yaml
 ---
 namespace: MySuperOrganization
 branch: modulesyncbranch
+pr_title: "Updates to module template files via modulesync"
+pr_labels:
+  - TOOLING
+  - MAINTENANCE
+  - MODULESYNC
 ```
 
-###### Gitlab
+###### GitLab
 
-```
+```yaml
 ---
 git_base: 'user@gitlab.example.com:'
 namespace: MySuperOrganization
@@ -258,7 +287,7 @@ branch: modulesyncbranch
 
 ###### Gerrit
 
-```
+```yaml
 ---
 namespace: stackforge
 git_base:  ssh://jdoe@review.openstack.org:29418/
@@ -350,11 +379,11 @@ current date, bumped (minor) version, and commit message.
 If `CHANGELOG.md` is absent in the repository, nothing will happen.
 
 
-#### Defining templates
+#### Working with templates
 
-As commented, files within moduleroot directory can be flat files or ERB templates. These files have direct access to @configs hash, which gets values from config_defaults.yml file and from the module being processed:
+As mentioned, files in the moduleroot directory must be ERB templates (they must have an .erb extension, or they will be ignored). These files have direct access to @configs hash, which gets values from config_defaults.yml file and from the module being processed:
 
-```
+```erb
 <%= @configs[:git_base] %>
 <%= @configs[:namespace] %>
 <%= @configs[:puppet_module] %>

data/lib/modulesync/cli.rb

@@ -85,6 +85,16 @@ module ModuleSync
              :type => :boolean,
              :desc => 'No-op mode',
              :default => false
+      option :pr,
+             :type => :boolean,
+             :desc => 'Submit GitHub PR',
+             :default => false
+      option :pr_title,
+             :desc => 'Title of GitHub PR',
+             :default => CLI.defaults[:pr_title] || 'Update to module template files'
+      option :pr_labels,
+             :desc => 'Labels to add to the GitHub PR',
+             :default => CLI.defaults[:pr_labels] || []
       option :offline,
              :type => :boolean,
              :desc => 'Do not run any Git commands. Allows the user to manage Git outside of ModuleSync.',

data/lib/modulesync/git.rb

@@ -151,11 +151,14 @@ module ModuleSync
       rescue ::Git::GitExecuteError => git_error
         if git_error.message =~ /working (directory|tree) clean/
           puts "There were no files to update in #{name}. Not committing."
+          return false
         else
           puts git_error
           raise
         end
       end
+
+      true
     end
 
     # Needed because of a bug in the git gem that lists ignored files as

data/lib/modulesync/util.rb

@@ -14,5 +14,15 @@ module ModuleSync
         {}
       end
     end
+
+    def self.parse_list(option_value)
+      if option_value.is_a? String
+        option_value.split(',')
+      elsif option_value.is_a? Array
+        option_value
+      else
+        []
+      end
+    end
   end
 end

data/lib/modulesync.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'octokit'
 require 'pathname'
 require 'modulesync/cli'
 require 'modulesync/constants'
@@ -9,6 +10,12 @@ require 'modulesync/settings'
 require 'modulesync/util'
 require 'monkey_patches'
 
+GITHUB_TOKEN = ENV.fetch('GITHUB_TOKEN', '')
+
+Octokit.configure do |c|
+  c.api_endpoint = ENV.fetch('GITHUB_BASE_URL', 'https://api.github.com')
+end
+
 module ModuleSync
   include Constants
 
@@ -89,6 +96,11 @@ module ModuleSync
   end
 
   def self.manage_module(puppet_module, module_files, module_options, defaults, options)
+    if options[:pr] && !GITHUB_TOKEN
+      STDERR.puts 'Environment variable GITHUB_TOKEN must be set to use --pr!'
+      raise unless options[:skip_broken]
+    end
+
     puts "Syncing #{puppet_module}"
     namespace, module_name = module_name(puppet_module, options[:namespace])
     unless options[:offline]
@@ -114,7 +126,27 @@ module ModuleSync
     if options[:noop]
       Git.update_noop(module_name, options)
     elsif !options[:offline]
-      Git.update(module_name, files_to_manage, options)
+      # Git.update() returns a boolean: true if files were pushed, false if not.
+      pushed = Git.update(module_name, files_to_manage, options)
+      return nil unless pushed && options[:pr]
+
+      # We only do GitHub PR work if the GITHUB_TOKEN variable is set in the environment.
+      repo_path = "#{namespace}/#{module_name}"
+      puts "Submitting PR '#{options[:pr_title]}' on GitHub to #{repo_path} - merges #{options[:branch]} into master"
+      github = Octokit::Client.new(:access_token => GITHUB_TOKEN)
+      pr = github.create_pull_request(repo_path, 'master', options[:branch], options[:pr_title], options[:message])
+      puts "PR created at #{pr['html_url']}"
+
+      # PR labels can either be a list in the YAML file or they can pass in a comma
+      # separated list via the command line argument.
+      pr_labels = Util.parse_list(options[:pr_labels])
+
+      # We only assign labels to the PR if we've discovered a list > 1. The labels MUST
+      # already exist. We DO NOT create missing labels.
+      unless pr_labels.empty?
+        puts "Attaching the following labels to PR #{pr['number']}: #{pr_labels.join(', ')}"
+        github.add_labels_to_an_issue(repo_path, pr['number'], pr_labels)
+      end
     end
   end
 

data/modulesync.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '0.9.0'
+  spec.version               = '0.10.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.50.0'
 
   spec.add_runtime_dependency 'git', '~>1.3'
+  spec.add_runtime_dependency 'octokit', '~>4.0'
   spec.add_runtime_dependency 'puppet-blacksmith', '~>3.0'
   spec.add_runtime_dependency 'thor'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: puppet-blacksmith
   requirement: !ruby/object:Gem::Requirement
@@ -179,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer