Puppet Community

so... were there any design thoughts?  A latex tangle/weave like mangling of the README.md in place or adding something like an .erb template?

that's right
<https://github.com/raphink/puppet-freeradius|https://github.com/raphink/puppet-freeradius>

<https://github.com/raphink/github-readme-generator>

<https://github.com/raphink/github-readme-generator/blob/master/lib/github_readme_generator/task.rb#L69-L77>

I assume there is a markdown parser that lets one manipulate a DOM?

FTR the idea on this module was two-fold, based on the `examples` dir:
• generate README from comments
• generate acceptance tests from code (see <https://github.com/raphink/puppet-freeradius/blob/master/spec/spec_helper_acceptance.rb#L5|https://github.com/raphink/puppet-freeradius/blob/master/spec/spec_helper_acceptance.rb#L5>)

<https://github.com/raphink/puppet-freeradius/blob/master/spec/acceptance/freeradius_spec.rb#L5|https://github.com/raphink/puppet-freeradius/blob/master/spec/acceptance/freeradius_spec.rb#L5>

this was to ensure that all examples were actually tested, and all tests actually documented

What I'm thinking about is if we can label the code blocks in the readme with the name of the `./example.pp` file, then we can have a release time rake target similar to `rake reference` to update those code blocks.

OK. FTR I'm not using puppet anymore so I won't touch that code. Feel free to fork anything, or I'm happy to transfer ownership if you'd like.

Copy. Thanks. I'm still at the whinging phase :wink:

<@U1QVBAUS2> if you want to give that a try within vox pupuli or adopt it, let me know

I have a gift card with ewouds name on it :wink:

yes but then you would also need to extract the code fragment for linting

which we should be doing anyways? :smile:

right, well if you put the fragment in `./example/foo.pp` the existing `lint` rake target picks it up

or we need to figure out how to get CI to look for markdown ``puppet sections to lint like some text editor plugins do

I don't think markdown has a standized way to tag a verbatium block

decades ago I used to extract C headers from a .tex file and it was easy to hack something up with labels

that was one of the ideas. and I think ewoud considered that as well

hmm, this page claims markdown code blocks can be labeled: <https://thesynack.com/posts/codeblock-labels-markdown/>

we have something similar in <https://github.com/voxpupuli/voxpupuli-acceptance#examples>

at least from a usability point of view.  It has been a very long time since I've looked at the guts of a matcher

so you can use it { expect(Pathname('...')).to apply.idempotently }

I was also thinking about writing up a structure so you could create spec/acceptance/example/bla_rspec.rb and do some additional magic to automatically set the subject

or spec/acceptance/{classes,defines} and use the same let(:params) structure as in unit tests

the more convergence between rspec-beaker and rspec-puppet the better!

can I get a review for <https://github.com/voxpupuli/puppet-python/pull/647>

now I've <https://github.com/voxpupuli/puppet-python/pull/642>

and <https://github.com/voxpupuli/puppet-python/pull/648>

:question: question :question:
it's the first time I'm trying to create a new release. Could you please tell me if this is correct:
1. I change metadata.json and I create a PR. End of story. 
2. I run bundle commands, until I run `bundle exec rake release`. This command is going to create a new metadata.json and we work with the module in the future, with the version number suffixed with `-rc0`

<@U8A9BTC9H> 1. You create a branch, bump the version in metadata.json, update the CHANGELOG and REFERENCE.md and open a PR with this.

When this PR is merged, you switch back to the master branch, git pull to be on the merge commit of the release PR and then `bundle exec rake release`.

<https://voxpupuli.org/docs/releasing_version/> &lt;-- Long version of the above

Is there anyone who can have a look at <https://github.com/voxpupuli/puppet-mongodb/pull/650>

If someone have another idea ? Datacat doesn't work on exported resources (or define/class type  :pensive:)