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

Clarify documentation for "Distributing Third-Party Packages with EUPS"

    XMLWordPrintable

    Details

    • Team:
      Architecture

      Description

      The page describing third party packages, https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html, is unclear on a couple points:

      1) When Updating a package, and not making a New package, it is not clear which of the steps in "Distributing the Package" are necessary.  (Just the tagging or tagging and publishing?)

      2) In "Distributing the Package" it should be clarified that the git tagging should all be done after the commits have been merged to master.

      3) There was a comment on Slack that perhaps the "publish" steps are unnecessary because of the new tagged dailies, but I don't know if this was in reference to updated and/or new packages.

      4) The link labeled "(installed using the lsstsw tool)" under "Updating the Package" is broken.

        Attachments

          Issue Links

            Activity

            No builds found.
            erykoff Eli Rykoff created issue -
            jhoblitt Joshua Hoblitt made changes -
            Field Original Value New Value
            Component/s Stack Documentation and UX [ 12880 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 31077 ]
            tjenness Tim Jenness made changes -
            Watchers Eli Rykoff, Jonathan Sick, Joshua Hoblitt [ Eli Rykoff, Jonathan Sick, Joshua Hoblitt ] Eli Rykoff, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim [ Eli Rykoff, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim ]
            tjenness Tim Jenness made changes -
            Description The page describing third party packages, [https://developer.lsst.io/build-ci/third_party.html,] is unclear on a couple points:

            1) When Updating a package, and not making a New package, it is not clear which of the steps in "Distributing the Package" are necessary.  (Just the tagging or tagging and publishing?)

            2) In "Distributing the Package" it should be clarified that the git tagging should all be done *after* the commits have been merged to master.

            3) There was a comment on Slack that perhaps the "publish" steps are unnecessary because of the new tagged dailies, but I don't know if this was in reference to updated and/or new packages.

            4) The link labeled "(installed using the lsstsw tool)" under "Updating the Package" is broken.
            The page describing third party packages, [https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html,] is unclear on a couple points:

            1) When Updating a package, and not making a New package, it is not clear which of the steps in "Distributing the Package" are necessary.  (Just the tagging or tagging and publishing?)

            2) In "Distributing the Package" it should be clarified that the git tagging should all be done *after* the commits have been merged to master.

            3) There was a comment on Slack that perhaps the "publish" steps are unnecessary because of the new tagged dailies, but I don't know if this was in reference to updated and/or new packages.

            4) The link labeled "(installed using the lsstsw tool)" under "Updating the Package" is broken.
            Hide
            tjenness Tim Jenness added a comment -

            I'm not entirely sure what we want to do with this ticket. The page has been modified since this ticket was filed and we also stopped using EUPS to distribute third party packages. Close as won't fix?

            Show
            tjenness Tim Jenness added a comment - I'm not entirely sure what we want to do with this ticket. The page has been modified since this ticket was filed and we also stopped using EUPS to distribute third party packages. Close as won't fix?
            tjenness Tim Jenness made changes -
            Team SQuaRE [ 10302 ] Architecture [ 10304 ]
            Hide
            erykoff Eli Rykoff added a comment -

            I agree that this is probably a dead-letter since we don't distribute packages via eups TaP anymore. However, https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html is still there and still has the same ambiguities as to the order of operations. (For example, https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html#distributing-the-package doesn't say that this happens after merging to master).

            Though maybe the solution is to archive this page?

            Show
            erykoff Eli Rykoff added a comment - I agree that this is probably a dead-letter since we don't distribute packages via eups TaP anymore. However, https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html is still there and still has the same ambiguities as to the order of operations. (For example, https://developer.lsst.io/stack/packaging-third-party-eups-dependencies.html#distributing-the-package doesn't say that this happens after merging to master). Though maybe the solution is to archive this page?
            Hide
            erykoff Eli Rykoff added a comment -

            And the link labeled "(installed using the lsstsw tool)" under "Updating the Package" is still broken.

            Show
            erykoff Eli Rykoff added a comment - And the link labeled "(installed using the lsstsw tool)" under "Updating the Package" is still broken.
            jsick Jonathan Sick made changes -
            Watchers Eli Rykoff, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim, Tim Jenness [ Eli Rykoff, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim, Tim Jenness ] Eli Rykoff, Joshua Hoblitt, Kian-Tat Lim, Tim Jenness [ Eli Rykoff, Joshua Hoblitt, Kian-Tat Lim, Tim Jenness ]
            ktl Kian-Tat Lim made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            Hide
            ktl Kian-Tat Lim added a comment -

            If you had turned your ticket description into draft text, you could probably have saved 3.5 years, but I might as well do it since it's not inconceivable that we'll have more of these soon (e.g. RFC-800 is a fork now but might not be in the future).

            Show
            ktl Kian-Tat Lim added a comment - If you had turned your ticket description into draft text, you could probably have saved 3.5 years, but I might as well do it since it's not inconceivable that we'll have more of these soon (e.g. RFC-800 is a fork now but might not be in the future).
            ktl Kian-Tat Lim made changes -
            Reviewers Eli Rykoff [ erykoff ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            ktl Kian-Tat Lim made changes -
            Assignee Kian-Tat Lim [ ktl ]
            erykoff Eli Rykoff made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            ktl Kian-Tat Lim made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            tjenness Tim Jenness made changes -
            Link This issue is duplicated by DM-13695 [ DM-13695 ]

              People

              Assignee:
              ktl Kian-Tat Lim
              Reporter:
              erykoff Eli Rykoff
              Reviewers:
              Eli Rykoff
              Watchers:
              Eli Rykoff, Joshua Hoblitt, Kian-Tat Lim, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins Builds

                  No builds found.