Commit Graph

537 Commits

Author SHA1 Message Date
jbondpdx bd96a46620 (PDOC-196) Correcting misinformation about supported YARD tags 2018-01-19 14:04:54 -08:00
Arjen Zonneveld 88f9dba407
Spelling README.md
paramter -> parameter
2017-12-11 16:26:39 +01:00
Rob Nelson 5ec86e9d1b
Add rgen as a runtime dependency
When using puppet-strings with a module that otherwise does not specify rgen in its Gemfile, this error was observed:
```
$ bundle exec puppet strings generate ./manifests/*.pp
Error: The 'rgen' gem must be installed in order to use this face.
Error: Try 'puppet help strings generate' for usage
```
Adding rgen to the Gemfile allows puppet strings to work, so it seems like a valid runtime dependency.
2017-12-07 14:17:52 -05:00
Jesse Scott 42285c74ce Merge pull request #148 from scotje/release_prep_1.1.1
(MAINT) Release prep for 1.1.1
2017-10-20 22:09:47 +00:00
Jesse Scott a00d53f6d8 Merge pull request #147 from scotje/maint_formatting_fixes
(MAINT) Fix up rubocop settings and clean up inconsistent indentation
2017-10-20 22:02:01 +00:00
Jesse Scott 264e2d1ca6 (MAINT) Release prep for 1.1.1 2017-10-20 14:57:36 -07:00
Jesse Scott e4ef0ed2f8 (MAINT) Fix up rubocop settings and clean up inconsistent indentation 2017-10-20 14:37:28 -07:00
Jesse Scott 99efcb156a Merge pull request #146 from smcelmurry/qeng-5344
(QENG-5344) Add beaker-abs for CI.next-i-fication
2017-10-13 17:40:57 +00:00
Jesse Scott ffd05a3608 (fixup) Update bundler before Travis runs 2017-10-13 10:35:14 -07:00
Spencer McElmurry dc25d9e631 (QENG-5344) Add beaker-abs for ci.next-i-fication
This is needed in order to work with always be scheduling on
CI.Next jenkins instances.
2017-10-05 15:27:01 -07:00
Jesse Scott cf19dc3cb8 Merge pull request #145 from ghoneycutt/puppet5
Support testing with Puppet 5
2017-08-15 17:30:07 +00:00
Garrett Honeycutt 891668d525 Support testing with Puppet 5 2017-08-09 09:53:57 -07:00
Maggie Dreyer ee15c54437 Merge pull request #144 from ghoneycutt/drop_support_for_old_releases
Drop support for old releases
2017-08-09 09:30:50 -07:00
Garrett Honeycutt 9048bed0d2 Support only the latest version of Puppet v4
Since Puppet v5 is out, we no longer need to support each point release
of Puppet v4.
2017-07-26 18:57:02 -04:00
Garrett Honeycutt 1892ed193b Use the supported ruby version for each Puppet version.
This patch moves from using a matrix of ruby and puppet version and then
excluding the incompatibilities to including supported versions. This
makes it much easier to see what is supported while also ensuring the
correct matrix of tests.

https://docs.puppet.com/puppet/4.10/about_agent.html
2017-07-26 18:55:14 -04:00
Scott Garman 9fc7fe2ff7 Merge pull request #136 from hashar/rake-task-args
Fix args handling for rake strings::generate
2017-07-18 08:15:30 -07:00
Antoine Musso fc2779202c Fix args handling for rake strings::generate
In the rake task strings::generate, the arguments json and yard_args
are not applied properly. The logic uses args.key?, however args is not
a Hash but a  Rake::TaskArguments (and Enumerable). There is now key?
method.

Use Rake::TaskArguments.has_key? instead.
2017-07-14 21:45:42 +02:00
Jesse Scott 65c753b605 Merge pull request #137 from declarativesystems/no_dates
(PDOC-160) Remove the timestamp from output
2017-06-05 17:12:06 -07:00
Geoff Williams 203610d67c (PDOC-160) Remove the timestamp from output
Prevent mass-changes to files by removing the date in the footer of each page.
Since the generation date isn't particularly useful and isn't tied to either
a git revision or a released version, this could be an easy way to address this
bug.  The files will of-course be regenerated but if there are no changes then
the content will be identical and git will not notice.
2017-06-05 20:56:13 +10:00
Jesse Scott 41a7c9c82a Merge pull request #142 from puppetlabs/fix-readme-md
Fix markdown for code blocks in a README list
2017-05-26 16:04:19 -07:00
Garrett Guillotte f6fcd7e1b4 Fix markdown for code blocks in a README list 2017-05-25 11:18:17 -07:00
Jesse Scott 492700a15b Merge pull request #140 from maju6406/patch-1
(maint) Fixing markdown formatting errors
2017-05-22 11:34:08 -07:00
Jesse Scott 1f4bab28d1 Merge pull request #141 from hfm/master
fix typo
2017-05-22 11:33:31 -07:00
OKUMURA Takahiro 928bb23f55
fix typo 2017-05-21 03:37:26 +09:00
Abir Majumdar a36ce30ba6 (maint) Fixing markdown formatting errors
Github markdown needs a space after a #
2017-03-20 14:58:22 -07:00
Will Hopper eaa3d58659 (PDOC-165) Bump version to 1.1.0 and update CHANGELOG 2017-03-20 11:45:17 -07:00
Jesse Scott ba1a653331 Merge pull request #138 from whopper/PDOC-161/master/summary
(PDOC-161) Add `summary` tag for short descriptions
2017-03-16 14:45:49 -07:00
Will Hopper a3f00d043f (maint) Update outdated rubocop checks 2017-03-16 14:22:07 -07:00
Will Hopper 8178c0beff (PDOC-161) Update README with an example usage of the summary tag 2017-03-16 12:51:56 -07:00
Will Hopper 4990576f61 (PDOC-161) Add `summary` tag for short descriptions
This tag is primarily meant to be applied to Puppet classes,
but it is also supported by every other construct that can be
documented with strings.
2017-03-16 12:51:53 -07:00
Will Hopper d334ef78c0 Merge pull request #135 from er0ck/acceptance/master/PDOC-144-acceptance_fix_windows_pre-suite
(pdoc-144) acceptance: fix windows pre suite
2017-02-06 17:07:50 -08:00
Eric Thompson 564a6fb7f3 (PDOC-144) fix recent commit's Rakefile changes when no platform is specified 2017-02-07 01:05:43 +00:00
Eric Thompson 7bc5fb7f7f (PDOC-144) acceptance: fix windows pre-suite
* install the correct CAs in the correct places so windows can install gems
* use a gem_command abstraction to find the correct puppet gem exe

[skip ci]
2017-02-07 00:35:33 +00:00
Eric Thompson 5908cc795d (PDOC-144) acceptance: fix windows pre-suite
* windows install requires type=aio so gem_command can find the right gem exe
* this change also allows easier command line use
  * by using a sensible default for the acceptance key

[skip ci]
2017-02-07 00:32:58 +00:00
Jesse Scott 5682ffa915 Merge pull request #134 from whopper/maint/add_maintainters
(maint) Add MAINTAINERS file
2017-01-11 13:20:58 -08:00
Will Hopper 6c8246ff11 (maint) Add MAINTAINERS file 2017-01-11 12:55:47 -08:00
Hailee Kenney ba4619e345 Merge pull request #132 from whopper/PDOC-155/master/pup4_type_doc
(PDOC-155) Allow type documentation in Puppet 4 code
2017-01-10 14:15:18 -08:00
Will Hopper 2d0a1f0c70 (maint) Put provider command in quotes in JSON test 2017-01-10 13:59:41 -08:00
Will Hopper 165170c08b (PDOC-155) Allow type documentation in Puppet 4 code
Because Puppet 4 is typed, parameter type information can
be automatically determined without any explicit documentation
in @param tags. However, users may desire to do so anyway for
consistency. This commit allows @param tags to include a [type]
in Puppet 4 code. Strings will emit a warning if the documented
type does not match the actual type. In such an event, the incorrect
documented type will be ignored in favor of the real one.
2017-01-10 13:59:38 -08:00
Hailee Kenney 5b7ee1901f Merge pull request #133 from whopper/maint/yard-0.9.5
(maint) Pin YARD to 0.9.5
2017-01-10 12:26:07 -08:00
Will Hopper 8ec6a68d98 (maint) Pin YARD to 0.9.5
There is currently a parsing bug in YAD 0.9.6 and above
which causes errors on certain strings with '/' characters.
We'll pin to YARD 0.9.5 until the issue is resolved on YARD's
side.

See https://github.com/lsegal/yard/issues/1054.
2017-01-10 12:24:05 -08:00
Jesse Scott 2710e7a8e9 Merge pull request #131 from HAIL9000/maint/master/correct_param_tag_example
(maint) Fix @param type examples in README
2016-12-20 12:45:42 -08:00
Hailee Kenney 303c1eda1f (maint) Fix @param type examples in README
Correct the examples of using a parameter type in the @param tag
so that they match how the YARD documentation suggests the tag
should be used.

http://www.rubydoc.info/gems/yard/file/docs/Tags.md#param
2016-12-20 11:43:14 -08:00
Jesse Scott 5ae446fcba Merge pull request #130 from whopper/PDOC-143/windows-readme
(PDOC-143) Add installation instructions for PE 3.8 in Windows
2016-12-02 12:17:03 -08:00
Will Hopper 30ffd147f1 (maint) Turn off unnecessary rubocop Bundler warnings 2016-12-02 11:38:40 -08:00
Will Hopper 9d18af4114 (PDOC-143) Add installation instructions for PE 3.8 in Windows 2016-12-02 11:19:56 -08:00
Jesse Scott 1bd8575acb Merge pull request #129 from whopper/PDOC-107/1.0-release
(PDOC-137) Bump version to 1.0.0 and update CHANGELOG
2016-11-28 12:35:12 -08:00
Will Hopper 0123e8f79b (PDOC-137) Bump version to 1.0.0 and update CHANGELOG 2016-11-28 12:28:12 -08:00
Will Hopper 94605205b3 Merge pull request #128 from jbondpdx/master
(PDOC-133) revise+edit strings readme
2016-11-23 13:58:20 -08:00
jbondpdx 1f9a99a37a (PDOC-133) Edits to Strings README 2016-11-23 12:55:55 -08:00