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

Create a CI job to generate manpages

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 4.10.11, PUP 5.3.6, PUP 5.5.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Sub-team:
    • Team:
      Platform Core
    • Sprint:
      Platform Core KANBAN
    • Release Notes:
      Not Needed
    • QA Risk Assessment:
      No Action

      Description

      Our man pages must be generated manually and are often out of sync when code changes are made to applications or puppet settings (defaults.rb). We should create a CI job in the per-component pipelines, similar to how we do localization.

      1. We need to add ronn as a gem dependency, only when running from bundler, not when installing puppet as a gem. Similar to what we do for gettext-setup.
      2. We need to run bundle exec rake gen_manpages to update the man pages
      3. If that succeeds, run git add man -m "..."
      4. Ensure the job that does automatic merge ups always resolves the conflicts as ours.

      /cc Maggie Dreyer, Branan Riley, Jorie Tappa, Garrett Guillotte

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jorie Jorie Tappa
              Reporter:
              josh Josh Cooper
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support