Details

    • Type: Task
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PDK 1.4.1
    • Component/s: None
    • Template:
    • Acceptance Criteria:
      Hide

      pdk build -h should show the help section with supporting flags.

      Show
      pdk build -h should show the help section with supporting flags.
    • Epic Link:
    • Team:
      Puppet Developer Experience
    • Release Notes:
      New Feature
    • Release Notes Summary:
      This is a new feature that provides the 'pdk build' command. This feature builds the module project into a package that can be uploaded to the Forge.
    • QA Risk Assessment:
      Needs Assessment

      Description

      Flags to support:
      --debug Will output extra information
      --format Will allow output in text or junit and also take in a file path to write to a file. Default: text.
      --target-dir Save tar.gz package to a specified file path. Default: <module_root>/pkg/.

      Add CLI subcommand for pdk build.

      This work should also include a compatibility command of pdk module build, similar to the what we did with pdk new module and pdk module generate.

      The subcommand should be hidden for now, until the feature is set to be released.

      Mock up of help:

      $ pdk build --help
      NAME
          build - Builds a package from the module that can be published to the Puppet Forge.
       
      USAGE
          pdk build [options]
       
      OPTIONS
             --target-dir                  Input the target directory where you want PDK 
                                                to write the package. Default is pkg/ within your module.
       
      OPTIONS FOR PDK
          -d --debug                     Enable debug output.
          -f --format=<value>            Specify desired output format. Valid
                                         formats are 'junit', 'text'. You may also
                                         specify a file to which the formatted
                                         output is sent, for example:
                                         '--format=junit:report.xml'. This option
                                         may be specified multiple times if each
                                         option specifies a distinct target file.
          -h --help                      Show help for this command.
             --version                   Show version of pdk.
      

      Mock-up of the shell session:

      $ cd my-module
      $ pdk build
      pdk (INFO): Building my-module version 1.0.0.
      Build of my-module has completed successfully. Built package can be found here: pkg/my-module-1.0.0.tar.gz.
      

      Document for inputs on console dialogue: https://docs.google.com/document/d/10HAJVpzkjfE80Mib-hBXpVdGbxtnuSOKPxN03J1fUWc/edit?usp=sharing

        Attachments

          Issue Links

            Activity

              jsd-sla-details-panel

                People

                • Assignee:
                  tim.sharpe Tim Sharpe
                  Reporter:
                  l.smith Lindsey Smith
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Zendesk Support