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

Documenteer seeds Git revision date and branch name if not present in metadata.yaml

    Details

      Description

      If last_revised and version are not present in metadata.yaml, then the Git commit date and branch name should be used while building metadata instead.

      Also updates lsst-technote-bootstrap to take advantage of automated metadata for new projects.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            See changes to both lsst-sqre/documenteer and lsst-sqre/lsst-technote-bootstrap

            Show
            jsick Jonathan Sick added a comment - See changes to both lsst-sqre/documenteer and lsst-sqre/lsst-technote-bootstrap
            Hide
            swinbank John Swinbank added a comment - - edited

            Very nice. I have only fairly trivial comments:

            • A test would be nice.
            • Why do you set a version requirement on GitPython in requirements.txt but not in setup.py?
            • Similarly (but less important), it'd be nice to be consistent with capitalization of "GitPython" vs. "gitpython". It's not of any real importance, but it caused me to spend 10 seconds wondering if it could be significant.
            • I am saddened by the regression of the default human-readable date format from %Y-%m-%d to %B %d, %Y!

            I hope our moaning on HipChat wasn't too much of a distraction from other things: sorry!

            Show
            swinbank John Swinbank added a comment - - edited Very nice. I have only fairly trivial comments: A test would be nice. Why do you set a version requirement on GitPython in requirements.txt but not in setup.py ? Similarly (but less important), it'd be nice to be consistent with capitalization of "GitPython" vs. "gitpython". It's not of any real importance, but it caused me to spend 10 seconds wondering if it could be significant. I am saddened by the regression of the default human-readable date format from %Y-%m-%d to %B %d, %Y ! I hope our moaning on HipChat wasn't too much of a distraction from other things: sorry!
            Hide
            jsick Jonathan Sick added a comment -

            Thanks for the review. I think I’ve fixed all the issues

            • reverted to ISO 8601 dates. Any specific reason why you favour rendering ISO 8601 dates over plain english in templated HTML?
            • added tests with mocks
            Show
            jsick Jonathan Sick added a comment - Thanks for the review. I think I’ve fixed all the issues reverted to ISO 8601 dates. Any specific reason why you favour rendering ISO 8601 dates over plain english in templated HTML? added tests with mocks formalized documenteer’s treatment of dependencies to be consistent with https://caremad.io/2013/07/setup-vs-requirement/
            Hide
            swinbank John Swinbank added a comment -

            Thanks, Jonathan Sick.

            Any specific reason why you favour rendering ISO 8601 dates over plain english in templated HTML

            I didn't actually mean for this to be a hard requirement of the review: sorry if it came across as such! In general, though, I think %Y-%m-%d is more internationally acceptable: your "plain English" version grates on my British ears (and obviously looks wrong to non-English speakers, but given the documents are in English that's inconsequential).

            formalized documenteer’s treatment of dependencies to be consistent with https://caremad.io/2013/07/setup-vs-requirement/

            I've not seen this before; interesting. Thanks for the link.

            Show
            swinbank John Swinbank added a comment - Thanks, Jonathan Sick . Any specific reason why you favour rendering ISO 8601 dates over plain english in templated HTML I didn't actually mean for this to be a hard requirement of the review: sorry if it came across as such! In general, though, I think %Y-%m-%d is more internationally acceptable: your "plain English" version grates on my British ears (and obviously looks wrong to non-English speakers, but given the documents are in English that's inconsequential). formalized documenteer’s treatment of dependencies to be consistent with https://caremad.io/2013/07/setup-vs-requirement/ I've not seen this before; interesting. Thanks for the link.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Reviewers:
                John Swinbank
                Watchers:
                John Swinbank, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel