Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-17065

Automatically version installation documentation for pipelines.lsst.io

    XMLWordPrintable

    Details

      Description

      This ticket implements a set of tooling in documenteer that allows us to rendering installation documentation in pipelines.lsst.io that is exactly appropriate for the EUPS tag of the stack being documented. Some examples of functionality are:

      • Include the right EUPS tag in the eups distrib install documentation line.
      • Reference the right Python/Conda dependency files for the EUPS tag
      • Populate the version labels throughout the documentation.

      Inside the stack documentation build container we can use the EUPS_TAG environment variable. (https://github.com/lsst-sqre/jenkins-dm-jobs/blob/master/pipelines/lib/util.groovy#L1155)

      An alternative would be to use the EUPS APIs to figure out what tag is currently installed (this might be useful for local builds by developers, but in that case perhaps it would be better have some sort of default fallback).

        Attachments

          Activity

          jsick Jonathan Sick created issue -
          jsick Jonathan Sick made changes -
          Field Original Value New Value
          Epic Link DM-16933 [ 238280 ]
          tjenness Tim Jenness made changes -
          Component/s pipelines_lsst_io [ 16812 ]
          jsick Jonathan Sick made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          jhoblitt Joshua Hoblitt made changes -
          Watchers Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim [ Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim ] Gabriele Comoretto, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim [ Gabriele Comoretto, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim ]
          jsick Jonathan Sick made changes -
          Reviewers Simon Krughoff [ krughoff ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          krughoff Simon Krughoff made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          jsick Jonathan Sick made changes -
          Story Points 2.7
          jsick Jonathan Sick made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Reviewers:
            Simon Krughoff
            Watchers:
            Gabriele Comoretto [X] (Inactive), John Swinbank, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim, Simon Krughoff
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins Builds

                No builds found.