modulesync 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cd854b2ba5a64f73b1051081fbf1e3bdbe39bbec2b7dacf5de3a3f37750625
-  data.tar.gz: d45c398dd5e7fc20d4bbf257ca0303bda0faa91ea49d3b6804d34fdbb25e1175
+  metadata.gz: fc930ee899499173ce75a299885bee85d967c158b6cfc7cc4113a73b6b7c82bf
+  data.tar.gz: 86575cd8683f4c89035d0f5018838bd3690d6a625e15480b7683fdd34e966e07
 SHA512:
-  metadata.gz: 38ae3613c9b28a0d679445350dcf6d625ad0db7156db8e26df7b4a4703a79713b471ce786d20d879a4bcdf8cd23830ac8277f259435f6fb191eede8a5a49ac9f
-  data.tar.gz: 62cacbdc9b002371957bc732727774c79d3b5783280469e3a2a34379265b784a8b6c0a6bccf1ce47ceb4bccea27cdb0273933b86381a37d57fd39e011b382d49
+  metadata.gz: 6759dc5e250c03c3bf157dfee1a4890dcbd1c986ab735bb01e996cb4e181aa0b901c91f7b5138129915496ed8f514a66e902a0fae44eb466bf125992ef44e03d
+  data.tar.gz: a13a5de75f58baae2a9ad16f958553bc158a9a045b88b2982348f921e3d084aca8f0df575395a8390ed8d7d8ba65c204c06911a8288e55a76ae664c02d4f9f74

data/.gitignore

@@ -1,5 +1,11 @@
-tmp/
-modules/
 *.gem
-Gemfile.lock
 .bundle/
+.ruby-version
+.vscode/
+Gemfile.lock
+bin/bundle
+bin/rspec
+modules/
+tmp/
+vendor/
+.vendor/

data/.rubocop.yml

@@ -7,6 +7,9 @@ AllCops:
     - 'tmp/**/*'
     - 'pkg/**/*'
     - 'lib/monkey_patches.rb'
+    - 'spec/**/*'
+    - 'Gemfile'
+    - 'Rakefile'
 
 Style/HashSyntax:
   Enabled: false

data/.rubocop_todo.yml

@@ -19,7 +19,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 105
+  Max: 107
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:

data/.travis.yml

@@ -2,23 +2,27 @@
 sudo: false
 language: ruby
 cache: bundler
-dist: trusty
+dist: focal
 script: 'bundle exec rake test'
+bundler_args: --without release
 rvm:
-  - 2.0
-  - 2.1.9
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.5
+  - 2.6
+  - 2.7
 notifications:
   email: false
+  irc:
+    on_success: always
+    on_failure: always
+    channels:
+      - "chat.freenode.org#voxpupuli-notifications"
 deploy:
   provider: rubygems
   api_key:
     secure: "Tbf1EbLEobIIox+fftJZADZsfQQ6kl0urcMNetK7NJzFo/negD/WyJIUj3kro/B7buyYADEjTui/JR4o8EPbugfM3ie5vYOd5k3AesSzbdr4BSwGe/cGbGOB7/PZuGfFLkb94/FiCU2mIwibkbh1rHWGlBoPj7ntL0+5ZtdvsM4="
   gem: modulesync
   on:
-    rvm: 2.4.0
+    rvm: 2.7
     tags: true
     all_branches: true
     repo: voxpupuli/modulesync

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+All notable changes to this project will be documented in this file.
+
+## [2.0.1](https://github.com/voxpupuli/modulesync/tree/2.0.1) (2020-10-06)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.0.0...2.0.1)
+
+**Fixed bugs:**
+
+- Use remote\_branch for PRs when specified [\#194](https://github.com/voxpupuli/modulesync/pull/194) ([raphink](https://github.com/raphink))
+
+**Merged pull requests:**
+
+- Allow newer puppet-blacksmith versions [\#197](https://github.com/voxpupuli/modulesync/pull/197) ([bastelfreak](https://github.com/bastelfreak))
+
+## [2.0.0](https://github.com/voxpupuli/modulesync/tree/2.0.0) (2020-08-18)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/1.3.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop support for Ruby 2.4 and older [\#191](https://github.com/voxpupuli/modulesync/pull/191) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Symbolize keys in managed\_modules except for module names [\#185](https://github.com/voxpupuli/modulesync/pull/185) ([raphink](https://github.com/raphink))
+
+**Fixed bugs:**
+
+- GitLab MR: undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#187](https://github.com/voxpupuli/modulesync/issues/187)
+- msync fails with nilClass error [\#172](https://github.com/voxpupuli/modulesync/issues/172)
+- Fix NoMethodError for --pr option \(caused by `module_options = nil`\) / introduce --noop [\#188](https://github.com/voxpupuli/modulesync/pull/188) ([bittner](https://github.com/bittner))
+- Allow empty module options in self.pr\(\) [\#186](https://github.com/voxpupuli/modulesync/pull/186) ([raphink](https://github.com/raphink))
+
+## [1.3.0](https://github.com/voxpupuli/modulesync/tree/1.3.0) (2020-07-03)
+
+* Expose --managed_modules_conf [#184](https://github.com/voxpupuli/modulesync/pull/184)
+* Allow absolute path for config files [#183](https://github.com/voxpupuli/modulesync/pull/183)
+* Add pr_target_branch option [#182](https://github.com/voxpupuli/modulesync/pull/182)
+* Allow to specify namespace in module_options [#181](https://github.com/voxpupuli/modulesync/pull/181)
+* Allow to override PR parameters per module [#178](https://github.com/voxpupuli/modulesync/pull/178)
+* Include the gitlab library (if we interact with gitlab), not github [#179](https://github.com/voxpupuli/modulesync/pull/179)
+
+## 2020-07-03 - 1.2.0
+
+* Add support for GitLab merge requests (MRs) [#175](https://github.com/voxpupuli/modulesync/pull/175)
+
+## 2020-05-01 - 1.1.0
+
+This release provides metadata in the ERB template scope which makes it easy to read files from inside the module. A possible application is reading metadata.json and generating CI configs based on that.
+
+* Add metadata to ERB template scope - [#168](https://github.com/voxpupuli/modulesync/pull/168)
+* Skip issuing a PR if one already exists for -b option - [#171](https://github.com/voxpupuli/modulesync/pull/171)
+* Correct the type on the pr-labels option to prevent a deprecation warning - [#173](https://github.com/voxpupuli/modulesync/pull/173)
+
 ## 2019-09-19 - 1.0.0
 
 This is the first stable release! 🎉
@@ -206,3 +260,6 @@ Also fixes the README to document the very important -m flag.
 
 This release adds support for other SSH-based git servers, which means
 gitlab is now supported.
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -3,4 +3,8 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '< 3.0' if RUBY_VERSION < '2.1'
-gem 'octokit', '~> 4.0'
+gem 'octokit', '~> 4.9'
+
+group :release do
+  gem 'github_changelog_generator', :require => false, :git => 'https://github.com/voxpupuli/github-changelog-generator', :branch => 'voxpupuli_essential_fixes'
+end

data/HISTORY.md

@@ -0,0 +1,227 @@
+## [1.3.0](https://github.com/voxpupuli/modulesync/tree/1.3.0) (2020-07-03)
+
+* Expose --managed_modules_conf [#184](https://github.com/voxpupuli/modulesync/pull/184)
+* Allow absolute path for config files [#183](https://github.com/voxpupuli/modulesync/pull/183)
+* Add pr_target_branch option [#182](https://github.com/voxpupuli/modulesync/pull/182)
+* Allow to specify namespace in module_options [#181](https://github.com/voxpupuli/modulesync/pull/181)
+* Allow to override PR parameters per module [#178](https://github.com/voxpupuli/modulesync/pull/178)
+* Include the gitlab library (if we interact with gitlab), not github [#179](https://github.com/voxpupuli/modulesync/pull/179)
+
+## 2020-07-03 - 1.2.0
+
+* Add support for GitLab merge requests (MRs) [#175](https://github.com/voxpupuli/modulesync/pull/175)
+
+## 2020-05-01 - 1.1.0
+
+This release provides metadata in the ERB template scope which makes it easy to read files from inside the module. A possible application is reading metadata.json and generating CI configs based on that.
+
+* Add metadata to ERB template scope - [#168](https://github.com/voxpupuli/modulesync/pull/168)
+* Skip issuing a PR if one already exists for -b option - [#171](https://github.com/voxpupuli/modulesync/pull/171)
+* Correct the type on the pr-labels option to prevent a deprecation warning - [#173](https://github.com/voxpupuli/modulesync/pull/173)
+
+## 2019-09-19 - 1.0.0
+
+This is the first stable release! 🎉
+
+* Use namespace in directory structure when cloning repositories - [#152](https://github.com/voxpupuli/modulesync/pull/152)
+* Fix minor typo in help output - [#165](https://github.com/voxpupuli/modulesync/pull/165)
+* Small improvements and fixes - [#166](https://github.com/voxpupuli/modulesync/pull/166)
+* Fix overwriting of :global values - [#169](https://github.com/voxpupuli/modulesync/pull/169)
+
+## 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
+
+This is an awesome release - Now honors the repo default branch[#142](https://github.com/voxpupuli/modulesync/pull/142)
+
+### Bugfixes
+
+  * Monkey patch ls_files until ruby-git/ruby-git#320 is resolved
+  * Reraise exception rather than exit so we can rescue a derived StandardError when using skip_broken option
+
+### Enhancements
+
+  * Add new option to produce a failure exit code on warnings
+  * Remove hard coding of managed_modules.yml which means that options passed to ModuleSync.update can override the filename
+
+## 2017-11-03 - 0.8.2
+
+### Summary
+
+This release fixes:
+  * Bug that caused .gitignore file handle to be left open - [#131](https://github.com/voxpupuli/modulesync/pull/131).
+  * Fixed switch_branch to use current_branch instead of master - [#130](https://github.com/voxpupuli/modulesync/pull/130).
+  * Fixed bug where failed runs wouldn't return correct exit code - [#125](https://github.com/voxpupuli/modulesync/pull/125).
+  * Fix typo in README link to Voxpupuli modulesync_config [#123](https://github.com/voxpupuli/modulesync/pull/123).
+
+## 2017-05-08 - 0.8.1
+
+### Summary
+
+This release fixes a nasty bug with CLI vs configuration file option handling: Before [#117](https://github.com/voxpupuli/modulesync/pull/117) it was not possible to override options set in `modulesync.yml` on the command line, which could cause confusion in many cases. Now the configuration file is only used to populate the default values of the options specified in the README, and setting them on the command line will properly use those new values.
+
+## 2017-05-05 - 0.8.0
+
+### Summary
+
+This release now prefers `.erb` suffixes on template files. To convert your moduleroot directory, run this command in your configs repo:
+
+        find moduleroot/ -type f -exec git mv {} {}.erb \;
+
+Note that any `.erb`-suffixed configuration keys in `config_defaults.yml`, and `.sync.yml` need to be removed by hand. (This was unreleased functionality, will not affect most users.)
+
+#### Refactoring
+
+- Prefer `.erb` suffixes on template files, issue deprecation warning for templates without the extension
+- Require Ruby 2.0 or higher
+
+#### Bugfixes
+
+- Fix dependency on `git` gem for diff functionality
+- Fix error from `git` gem when diff contained line ending changes
+
+## 2017-02-13 - 0.7.2
+
+Fixes an issue releasing 0.7.1, no functional changes.
+
+## 2017-02-13 - 0.7.1
+
+Fixes an issue releasing 0.7.0, no functional changes.
+
+## 2017-02-13 - 0.7.0
+
+### Summary
+
+This is the first release from Vox Pupuli, which has taken over maintenance of
+modulesync.
+
+#### Features
+- New `msync update` arguments:
+    - `--git-base` to override `git_base`, e.g. for read-only git clones
+    - `-s` to skip the current module and continue on error
+    - `-x` for a negative filter (blacklist) of modules not to update
+- Add `-a` argument to `msync hook` to pass additional arguments
+- Add `:git_base` and `:namespace` data to `@configs` hash
+- Allow `managed_modules.yml` to list modules with a different namespace
+- Entire directories can be listed with `unmanaged: true`
+
+#### Refactoring
+- Replace CLI optionparser with thor
+
+#### Bugfixes
+- Fix git 1.8.0 compatibility, detecting when no files are changed
+- Fix `delete: true` feature, now deletes files correctly
+- Fix handling of `:global` config entries, not interpreted as a path
+- Fix push without force to remote branch when no files have changed (#102)
+- Output template name when ERB rendering fails
+- Remove extraneous whitespace in `--noop` output
+
+## 2015-08-13 - 0.6.1
+
+### Summary
+
+This is a bugfix release to fix an issue caused by the --project-root flag.
+
+#### Bugfixes
+
+- Fix bug in git pull function (#55)
+
+##2015-08-11 - 0.6.0
+
+### Summary
+
+This release adds two new flags to help modulesync better integrate with CI tools.
+
+#### Features
+
+- Add --project-root flag
+- Create --offline flag to disable git functionality
+
+#### Bugfixes
+
+- Fix :remote option for repo
+
+#### Maintenance
+
+- Added tests
+
+## 2015-06-30 - 0.5.0
+
+### Summary
+
+This release adds the ability to sync a non-bare local git repo.
+
+#### Features
+
+- Allow one to sync non-bare local git repository
+
+## 2015-06-24 - 0.4.0
+
+### Summary
+
+This release adds a --remote-branch flag and adds a global key for template
+config.
+
+#### Features
+
+- Expose --remote-branch
+- Add a global config key
+
+#### Bugfixes
+
+- Fix markdown syntax in README
+
+## 2015-03-12 - 0.3.0
+
+### Summary
+
+This release contains a breaking change to some parameters exposed in
+modulesync.yml. In particular, it abandons the user of git_user and
+git_provider in favor of the parameter git_base to specify the base part of a
+git URL to pull from. It also adds support for gerrit by adding a remote_branch
+parameter for modulesync.yml that can differ from the local branch, plus a
+number of new flags for updating modules.
+
+#### Backwards-incompatible changes
+
+- Remove git_user and git_provider_address as parameters in favor of using
+  git_base as a whole
+
+#### Features
+
+- Expose the puppet module name in the ERB templates
+- Add support for gerrit by:
+  - Adding a --amend flag
+  - Adding a remote_branch parameter for modulesync.yml config file that can
+    differ from the local branch
+  - Adding a script to handle the pre-commit hook for adding a commit id
+  - Using git_base to specify an arbitrary git URL instead of an SCP-style one
+- Add a --force flag (usually needed with the --amend flag if not using gerrit)
+- Add --bump, --tag, --tag-pattern, and --changelog flags
+
+#### Bugfixes
+
+- Stop requiring .gitignore to exist
+- Fix non-master branch functionality
+- Add workarounds for older git versions
+
+## 2014-11-16 - 0.2.0
+
+### Summary
+
+This release adds the --filter flag to filter what modules to sync.
+Also fixes the README to document the very important -m flag.
+
+## 2014-9-29 - 0.1.0
+
+### Summary
+
+This release adds support for other SSH-based git servers, which means
+gitlab is now supported.

data/README.md

@@ -176,27 +176,50 @@ touching the modules, you can deactivate the hook.
 msync hook deactivate
 ```
 
-#### Submitting PRs to GitHub
+#### Submitting PRs/MRs to GitHub or GitLab
 
-You can have modulesync submit Pull Requests on GitHub automatically with the
-`--pr` CLI option.
+You can have modulesync submit Pull Requests on GitHub or Merge Requests on
+GitLab automatically with the `--pr` CLI option.
 
 ```
 msync update --pr
 ```
 
-You must set `GITHUB_TOKEN` in your environment for this to work. Other options
-include:
+In order for GitHub PRs or GitLab MRs to work, you must either provide
+the `GITHUB_TOKEN` or `GITLAB_TOKEN` environment variables,
+or set them per repository in `managed_modules.yml`, using the `github` or
+`gitlab` keys respectively.
 
-* 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.
+For GitHub Enterprise and self-hosted GitLab instances you also need to set the
+`GITHUB_BASE_URL` or `GITLAB_BASE_URL` environment variables, or use the
+`base_url` parameter in `managed_modules.yml`:
 
-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.
+```yaml
+---
+repo1:
+  github:
+    token: 'EXAMPLE_TOKEN'
+    base_url: 'https://api.github.com/'
+
+repo2:
+  gitlab:
+    token: 'EXAMPLE_TOKEN'
+    base_url: 'https://git.example.com/api/v4'
+```
+
+Then:
+
+* Set the PR/MR title with `--pr-title` or in `modulesync.yml` with the
+  `pr_title` attribute.
+* Assign labels to the PR/MR 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.
+* Set the target branch with `--pr_target_branch` or in `modulesync.yml` with
+  the `pr_target_branch` attribute.
+
+More details for GitHub:
+
+* Octokit [`api_endpoint`](https://github.com/octokit/octokit.rb#interacting-with-the-githubcom-apis-in-github-enterprise)
 
 ### Using Forks and Non-master branches
 
@@ -253,13 +276,15 @@ 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')
+* `namespace` : Namespace of the projects to manage (Default: 'puppetlabs').
+  This value can be overridden in the module name (e.g. 'namespace/mod') or by
+  using the `namespace` key for the module in `managed_modules.yml`.
 * `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.
+* `pr_title` : The title to use when submitting PRs/MRs to GitHub or GitLab.
+* `pr_labels` : A list of labels to assign PRs/MRs created on GitHub or GitLab.
 
 ##### Example
 
@@ -389,6 +414,23 @@ As mentioned, files in the moduleroot directory must be ERB templates (they must
 <%= @configs[:puppet_module] %>
 ```
 
+Alternatively some meta data is passed to the template. This will allow you to add custom Ruby extensions inside the
+template, reading other files from the module, to make the template system more adaptive.
+
+```erb
+module: <%= @metadata[:module_name] %>
+target: <%= @metadata[:target_file] %>
+workdir: <%= @metadata[:workdir] %>
+```
+
+Will result in something like:
+
+```
+module: puppet-test
+target: modules/github-org/puppet-test/test
+workdir: modules/github-org/puppet-test
+```
+
 The Templates
 -------------