[PUP-7398] deprecate puppet module generate Created: 2017/03/24  Updated: 2018/05/14  Resolved: 2018/02/15

Status: Closed
Project: Puppet
Component/s: PMT
Affects Version/s: PUP 4.10.0, PUP 4.10.z, PUP 5.y
Fix Version/s: PUP 5.4.0

Type: Task Priority: Normal
Reporter: David Schmitt Assignee: Unassigned
Resolution: Fixed Votes: 1
Labels: resolved-issue-added
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
blocks PDK-795 Deprecate puppet module generate in docs Closed
relates to PUP-8716 Remove puppet module generate functio... Closed
Acceptance Criteria:
  • When I generate a new module using puppet module generate , I'm made aware of the fact that this piece of functionality is going away, and is replaced by pdk new module.
  • the docsite mentions puppet module generate only for SEO pointing to PDK docs.
Epic Link: PMT Improvements
Team: Puppet Developer Experience
Release Notes: Deprecation
Release Notes Summary: The `puppet module generate` command is deprecated and will be removed in a future release. To create modules, use the [Puppet Development Kit](https://puppet.com/download-puppet-development-kit) instead.
QA Risk Assessment: Needs Assessment


The PDK v1 supersedes puppet module generate and provides a unified "new module" template.

Since it is not a front-line operational feature, I would not be opposed to replacing puppet module generate in puppet 6 with just a message pointing to pdk new module, without any deprecation, but that's not my decision to make.

cc Lindsey Smith Josh Cooper

Comment by Josh Cooper [ 2017/03/24 ]

IIRC, you can pass a skeleton to puppet module generate for all of the boiler plate logic. Would that be sufficient or does the generate command need to change?

Comment by David Schmitt [ 2017/04/04 ]

IIRC the only thing you can do with pmg is override the template by putting a new template into ~/.puppet(labs)/var/puppet-module/skeleton (see e.g. https://github.com/garethr/puppet-module-skeleton#installation).

Comment by David Schmitt [ 2018/01/30 ]

Now that the PDK is out and about, I've reworded this ticket.

Josh Cooper, should you not feel responsible for this work, feel free to re-assign to the PDE team, in which case I'll make it happen as described.

Comment by Jean Bond [ 2018/01/30 ]

Just a vote up from Docs here. I'd love to be able to just tell users not to use `puppet module generate` any more.

Comment by Josh Cooper [ 2018/01/31 ]

Merged to master in https://github.com/puppetlabs/puppet/commit/f145a2b8fe0b8a779fb97846f653bc612b350fa7

Comment by Kenn Hussey [ 2018/02/05 ]

Bryan Jen please add release notes for this issue, if needed. Thanks!

Comment by Casey Williams [ 2018/02/12 ]

This has passed CI; Marking as resolved in advance of the 5.4.0 release.

Generated at Sat Jul 11 02:01:47 PDT 2020 using Jira 8.5.2#805002-sha1:a66f9354b9e12ac788984e5d84669c903a370049.