Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-3963

Error message gives wrong advice for allowed module names

    XMLWordPrintable

Details

    • Platform Core
    • Platform Core KANBAN
    • Not Needed
    • This change adds clarification to an error message users see if their module name does not satisfy requirements. No documentation updated are needed.
    • Manual

    Description

      Under some conditions, Puppet will issue an error message like Error: Invalid module name .gitignore; module names must be alphanumeric (plus '-'), not '.gitignore'.

      That's wrong! You should definitely never have hyphens in your module names, but underscores are encouraged.

      The docs do not list hyphens as valid characters in module and class names, and we've publicly stated for years that it's a bug that it works and we'll make it stop working at our earliest convenience.

      Here's the relevant code:

      https://github.com/puppetlabs/puppet/blob/master/lib/puppet/module.rb#L343

      Attachments

        Activity

          People

            kris.bosland Kris Bosland
            nick.fagerlund Nicholas Fagerlund
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Zendesk Support