#939292 ITP: puppet-development-kit -- A CLI to facilitate easy, unified development workflows for Puppet modules

#939292#5
Date:
2019-09-02 21:11:44 UTC
From:
To:
* Package name    : ruby-pdk
  Version         : 1.13.0
  Upstream Author : Puppet, Inc.
* URL             : https://github.com/puppetlabs/pdk
* License         : Apache License 2.0
  Programming Lang: Ruby
  Description     : A CLI to facilitate easy, unified development workflows for Puppet modules

The Puppet Development Kit (PDK) includes key Puppet code development and
testing tools for Linux, Windows, and OS X workstations, so you can install
one package with the tools you need to create and validate new modules.

PDK includes testing tools, a complete module skeleton, and command line tools
to help you create, validate, and run tests on Puppet modules. PDK also
includes all dependencies needed for its use.


This package is the very useful helper that's been adopted by the puppet
community to help out building new modules and maintaining them. It also helps
with publishing modules to forge.puppet.com, which is the community module
repository.

Puppet, up to the 5.x branch, has had a builtin command "puppet module build"
that can create a tar archive with the relevant files placed in a layout
that's acceptable for publication on forge.puppet.com. This builtin command
is marked as deprecated in puppet 5.x and was removed in the 6.x branch. This
means that puppet users now need to use pdk for publishing their modules.

pdk also interacts with other tools, some of which are already packaged in
debian, to help users validate the syntax and code style of theire modules but
also to write unit tests.

the upstream project vendors all of those additional tools and the ones that
are not yet packaged yet would need to be packaged separately for debian. This
currently includes the metadata-json-lint and rspec-puppet-facts ruby gems

I plan to maintain this package and the dependencies that I will need to
package additionally within the ruby team.

#939292#10
Date:
2019-09-03 04:37:10 UTC
From:
To:
I've discussed the name a bit on different channels today and the folks
in the ruby team told me that calling it "ruby-pdk" would be a mistake
since it's not a library but rather a binary.

Also, just calling the package "pdk" seems to be too confusing since it
sounds very generic.

So for now the consensus seems to point towards naming this package
"puppet-development-kit" instead in order to make it obvious what it is
and easy to find.

#939292#17
Date:
2020-02-29 21:57:33 UTC
From:
To:
FYI I saw that there was an RFP open for puppet-development-kit, which I
had missed earlier: #879271

I've closed this other bug report since this one aims to fulfill it.

#939292#22
Date:
2020-07-17 20:39:05 UTC
From:
To:
Hi Gabriel,

do you make progress with uploading puppet-development-kit? Do you need a
hand?

   Thorsten

#939292#27
Date:
2020-07-17 21:17:41 UTC
From:
To:
Hello Thorsten,

thanks for suggesting your help!

the current situation is that I've packaged "most of the dependencies"
with help from folks in the ruby team.

I've sent a progression update on the puppet packaging list:

https://alioth-lists.debian.net/pipermail/pkg-puppet-devel/2020-July/012146.html

to summarize the current status:

* I'm stuck on ruby-spdx-licenses : I've asked upstream and SPDX about
what licensing should be applied to the .json file that the library
"vendors" and I still haven't received any feedback from SPDX. I
*believe* that some form of creative commons license could apply given
what I've found on their website (see details on the puppet pkg mailing
list).
  * this also blocks metadata-json-lint -- maybe we can start work on
packaging this thing regardless of the licensing issues for
spdx-licenses, then we'll be closer to the goal.

* I've worked on ruby-pathspec and I'm almost done with it. if I can
find some free time soon, I'll try and upload it to debian archives.

* the next "easy" batch of dependencies is ruby-rspec-puppet-facts,
facterdb and jgrep.