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

docsteady: include timestamp of Jira extraction in LaTeX output

    XMLWordPrintable

    Details

    • Team:
      Architecture
    • Urgent?:
      No

      Description

      The automated time-stamping in our DM LaTeX workflows is generally based on the date of the last commit to the document repo.  The way the new automated workflows for test reports are now configured, the extraction from Jira to LaTeX is done via a manually-triggered step in the workflow.  Subsequent rebuilds of the document by CI workflows may happen on future dates, possibly far in the future (e.g., if we need to make a change to the LTD system and rebuild documents).  In order to avoid any implication that the Jira extraction was re-run as part of that workflow, I suggest that docsteady write the wall-clock time at which it was run into its LaTeX output.

      I would suggest that this time stamp replace the use of \vcsDate in the document's \date header, and that we add a boilerplate sentence to the document like:

      "This document is based on content automatically extracted from the Jira test database on (docsteady-run-timestamp).  The most recent change to the document repository was on \vcsDate."

        Attachments

          Activity

          Hide
          womullan Wil O'Mullane added a comment -

          see DMTR-302 master for an example

           

          Show
          womullan Wil O'Mullane added a comment - see DMTR-302 master for an example  
          Hide
          womullan Wil O'Mullane added a comment -

          you should now get 2.1.3rc1  if you do a new docgen

          Show
          womullan Wil O'Mullane added a comment - you should now get 2.1.3rc1  if you do a new docgen
          Hide
          womullan Wil O'Mullane added a comment -

          gregory  reviewed on github

          Show
          womullan Wil O'Mullane added a comment - gregory  reviewed on github

            People

            Assignee:
            womullan Wil O'Mullane
            Reporter:
            gpdf Gregory Dubois-Felsmann
            Reviewers:
            Gregory Dubois-Felsmann
            Watchers:
            Gregory Dubois-Felsmann, Simon Krughoff, Wil O'Mullane
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: