Skip to content

Commit

Permalink
Merge pull request #98 from peterhuene/rewrite
Browse files Browse the repository at this point in the history
(PDOC-63) Code refactoring, fix up, and lots of new functionality.
  • Loading branch information
whopper committed Sep 16, 2016
2 parents b7472d5 + 01913fc commit 7ae8e74
Show file tree
Hide file tree
Showing 182 changed files with 5,518 additions and 4,063 deletions.
11 changes: 10 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tmtags

## VIM
*.swp
tags
/tags

## BUNDLER
.bundle
Expand All @@ -24,3 +24,12 @@ Gemfile.lock

## MODULE BUILDS
**/pkg

## RubyMine
/.idea/

## rvm/rbenv
/.ruby-version

## YARD output
/doc/
2 changes: 1 addition & 1 deletion .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ AllCops:
Exclude:
# Ignore HTML related things
- '**/*.erb'
- 'lib/puppetx/puppetlabs/strings/yard/templates/**/*'
- 'lib/puppet-strings/yard/templates/**/*'

Lint/ConditionPosition:
Enabled: true
Expand Down
4 changes: 2 additions & 2 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
--exclude lib/puppetx/puppetlabs/strings/yard/templates/
--exclude lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb
--exclude lib/puppet-strings/yard/templates/
--no-private
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
###Features
- Support for JSON output **(PDOC-23)**
- Strings now has the ability to produce a JSON representation of a given puppet module
- The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppetlabs-strings/blob/master/json_dom.md)
- For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppetlabs-strings/blob/master/README.md#running-puppet-strings)
- The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/master/json_dom.md)
- For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#running-puppet-strings)
- Migrate to ruby gems as a distribution method **(PDOC-28)**
- This is the last release of strings that will be available as a puppet module
- The 0.4.0 release will be released concurrently as a ruby gem
Expand Down
14 changes: 7 additions & 7 deletions COMMITTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ merged.
**security** - Where critical security fixes are merged. These change sets
will then be merged into release branches independently from one another. (i.e.
no merging up). Please do not submit pull requests against the security branch
and instead report all security related issues to security@puppetlabs.com as
and instead report all security related issues to security@puppet.com as
per our security policy published at
[https://puppetlabs.com/security/](https://puppetlabs.com/security/).
[https://puppet.com/security/](https://puppet.com/security/).

Committer Guide
====
Expand Down Expand Up @@ -84,8 +84,8 @@ applied to earlier minor releases of a major release, but the patches should
first be merged into the `security` branch. Security patches should be merged
by Puppet Labs staff members. Pull requests should not be submitted with the
security branch as the base branch. Please send all security related
information or patches to security@puppetlabs.com as per our [Security
Policy](https://puppetlabs.com/security/).
information or patches to security@puppet.com as per our [Security
Policy](https://puppet.com/security/).

The CI systems are configured to run against `master`. Over time, this branch
will refer to different versions, but its name will remain fixed to avoid having
Expand Down Expand Up @@ -118,7 +118,7 @@ This section aims to provide guidelines for being a good commit citizen by
paying attention to our automated build tools.

* Don’t push on a broken build. (A broken build is defined as a failing job
in the [Puppet FOSS](https://jenkins.puppetlabs.com/view/Puppet%20FOSS/)
in [Puppet Strings](https://jenkins.puppetlabs.com/job/platform_puppet-strings_unit-ruby_master/)
page.)
* Watch the build until your changes have gone through green
* Update the ticket status and target version. The target version field in
Expand All @@ -143,7 +143,7 @@ First, the committer pulls down the branch using the `hub` gem. This tool
automates the process of adding the remote repository and creating a local
branch to track the remote branch.

$ hub checkout https://github.com/puppetlabs/puppetlabs-strings/pull/123
$ hub checkout https://github.com/puppetlabs/puppet-strings/pull/123
Branch jeffmccune-pdoc-34_fix_foo_error set up to track remote branch pdoc-34-fix_foo_error from jeffmccune.
Switched to a new branch 'jeffmccune-pdoc-34_fix_foo_error'

Expand Down Expand Up @@ -178,7 +178,7 @@ Please note, the checklist should be complete at this point. It's helpful to mak
sure your local branches are up to date to avoid one of the branches failing to fast
forward while the other succeeds.

$ git push puppetlabs master:master
$ git push origin master:master

That's it! The committer then updates the pull request, updates the issue in
our issue tracker, and keeps an eye on the [build
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ a ticket number.

## Submitting Changes

* Sign the [Contributor License Agreement](http://links.puppetlabs.com/cla).
* Sign the [Contributor License Agreement](http://links.puppet.com/cla).
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the puppetlabs organization.
* Update your Jira ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
Expand All @@ -81,9 +81,9 @@ a ticket number.

# Additional Resources

* [More information on contributing](http://links.puppetlabs.com/contribute-to-puppet)
* [More information on contributing](http://links.puppet.com/contribute-to-puppet)
* [Bug tracker (Jira)](http://tickets.puppetlabs.com)
* [Contributor License Agreement](http://links.puppetlabs.com/cla)
* [Contributor License Agreement](http://links.puppet.com/cla)
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* #puppet-dev IRC channel on freenode.org
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ gemspec

gem 'rgen'
gem 'redcarpet'
gem "yard", "~> 0.8.7"
gem 'yard', '~> 0.9.5'

puppetversion = ENV['PUPPET_VERSION']

Expand Down

0 comments on commit 7ae8e74

Please sign in to comment.