Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(FM-8422) Make library releasable as a Puppet module #8

Merged
merged 2 commits into from
Oct 17, 2019
Merged

(FM-8422) Make library releasable as a Puppet module #8

merged 2 commits into from
Oct 17, 2019

Conversation

michaeltlombardi
Copy link
Contributor

Prior to this commit the library code could only be released
as a ruby gem. This commit adds the necessary metadata and
documentation for it to be released as a Puppet module upon
which other Puppet modules may depend and thereby use the
manager and helpers.

@michaeltlombardi michaeltlombardi requested a review from a team as a code owner October 17, 2019 05:20
@michaeltlombardi michaeltlombardi changed the title (FM-8422) Make library releasable as a Puppet module (WIP) (FM-8422) Make library releasable as a Puppet module Oct 17, 2019
@michaeltlombardi
Copy link
Contributor Author

Open question: Do we actually want to do a build + release of a the puppet module including all the cruft here, or do we want a rake task that can clean things up for a much slimmer release (which includes only the library, changelog, appropriate readme, etc, dropping the spec/images/etc).

metadata.json Outdated Show resolved Hide resolved
@@ -0,0 +1,86 @@
# pwshlib

This module enables you to leverage the `ruby-pwsh` gem to execute PowerShell from within your Puppet providers without having to instantiate and tear down a PowerShell process for each command called.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The forge will still show the regular README.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I had a think about this last night, this is one of the problems with having it all in one repo.

I think a build task could rejigger things long enough to do a pdk build, then put them back, but I don't think rewriting the main readme to make more sense on the forge is the right move.

@DavidS
Copy link
Contributor

DavidS commented Oct 17, 2019

If you want to slim down the module tarball, have a look at the .pmtignore which can be used to flag files for ignoring when building into the module.

Either way, as a 0.1.0, this is good enough for me.

@michaeltlombardi
Copy link
Contributor Author

Added a .pmtignore and cleaned up the metadata whoopsy.

@michaeltlombardi michaeltlombardi changed the title (WIP) (FM-8422) Make library releasable as a Puppet module (FM-8422) Make library releasable as a Puppet module Oct 17, 2019
.pmtignore Outdated
Gemfile
Gemfile.lock
Rakefile
ruby-pwsh.gemspec
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit.

Prior to this commit the library code could only be released
as a ruby gem. This commit adds the necessary metadata and
documentation for it to be released as a Puppet module upon
which other Puppet modules may depend and thereby use the
manager and helpers.
@RandomNoun7 RandomNoun7 merged commit 398244f into puppetlabs:master Oct 17, 2019
@michaeltlombardi michaeltlombardi added the enhancement New feature or request label Oct 25, 2019
@michaeltlombardi michaeltlombardi deleted the ticket/master/FM-8422-add-metadata.json branch December 3, 2019 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants