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

Create an RFC for change-controlled DM document Git branch and release policy

    Details

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

      Description

      Wil, Frossie, Tim, and I have discussed a new change-controlled document Git repository workflow to replace the current policy (release on master, work on draft).

      The basic features of the new workflow are:

      • Development on master in ticket branches. In general, document development should mirror code development workflows.
      • Release branches (named after the corresponding RFC or LCR) that are never merged back to master.
      • The release manager backports commits on the release branches (amendments requested by a CCB) to the master branch.
      • Tags for docushare upload number and document version.
      • A moving tag for the docushare preferred version.

      These tags are an API for LSST the Docs (lsst.io) and for future DocuShare automation.

        Attachments

          Issue Links

            Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-11854 [ 34354 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-10548 [ DM-10548 ]
            tjenness Tim Jenness made changes -
            Watchers Frossie Economou, Jonathan Sick, Tim Jenness, Wil O'Mullane [ Frossie Economou, Jonathan Sick, Tim Jenness, Wil O'Mullane ] Frossie Economou, John Swinbank, Jonathan Sick, Tim Jenness, Wil O'Mullane [ Frossie Economou, John Swinbank, Jonathan Sick, Tim Jenness, Wil O'Mullane ]
            jsick Jonathan Sick made changes -
            Attachment doc-release-sketch.png [ 29947 ]
            jsick Jonathan Sick made changes -
            Attachment document_workflow.pdf [ 29964 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 2.5
            jsick Jonathan Sick made changes -
            Link This issue is triggered by RFC-401 [ RFC-401 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-12304 [ DM-12304 ]
            jsick Jonathan Sick made changes -
            Story Points 2.5 4.8
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-12356 [ DM-12356 ]
            jsick Jonathan Sick made changes -
            Reviewers Tim Jenness [ tjenness ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            tjenness Tim Jenness made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            tjenness Tim Jenness made changes -
            Link This issue is triggered by DM-10548 [ DM-10548 ]
            tjenness Tim Jenness made changes -
            Link This issue relates to DM-10548 [ DM-10548 ]

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Reviewers:
                Tim Jenness
                Watchers:
                Frossie Economou, John Swinbank, Jonathan Sick, Tim Jenness, Wil O'Mullane
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel