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

Ook: Capture document creation date from git repository

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: www_lsst_io
    • Labels:
      None

      Description

      We want to identify a document's creation date in the www.lsst.io documentation portal in order to provide context about new documents at are appearing.

      We can start doing this by adapting Ook to look at the underlying Git repository and capturing the date of commits on the HEAD branch. In the general case, this is the date of the first commit. For technotes/documents, this should be the date of the second commit that modifies the source format (tex or rst) files to avoid capturing the date when the bot modified the content (an alternative might be too look at the commit author/committer info, and avoid commits by the bot, keeping in mind that sqrbot-jr/templatebot might impersonate the real user to some extent).

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            Released as Ook version 0.4.0:

            In this release, documents are ingested with a new sourceCreationTimestamp. This timestamp corresponds to the time when a document was initially created. A new workflow, get_github_creation_date can be used to infer this creation date on the basis of the first GitHub commit on the default branch that was not made by SQuaRE Bot (or any email/name corresponding to a bot) during the initial template instantiation.

            Related to this, Ook is now configured as a GitHub App: https://github.com/apps/ook-rubin-observatory

            Show
            jsick Jonathan Sick added a comment - Released as Ook version 0.4.0: In this release, documents are ingested with a new sourceCreationTimestamp . This timestamp corresponds to the time when a document was initially created. A new workflow, get_github_creation_date can be used to infer this creation date on the basis of the first GitHub commit on the default branch that was not made by SQuaRE Bot (or any email/name corresponding to a bot) during the initial template instantiation. Related to this, Ook is now configured as a GitHub App: https://github.com/apps/ook-rubin-observatory

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  CI Builds

                  No builds found.