Skip to content

Commit e6e75c8

Browse files
Merge pull request #725 from lsst-dm/tickets/DM-52110
DM-52110: Move up the instructions regd. manifest.remap
2 parents eb63bd7 + 442bc24 commit e6e75c8

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

stack/adding-a-new-package.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,12 @@ Top-level product dependency
9090

9191
The new package then needs to be added to the :file:`ups/*.table` file (and possibly the :file:`ups/*.cfg` file if this is a C++ package) of one or more other packages in the stack where it is used so that the build system can work out the correct dependency tree.
9292
Table files should use ``setupRequired(package_name)`` or ``setupOptional(package_name)`` as necessary; test data packages are usually optional to allow releases to be made without requiring large additional data packages to be included.
93+
9394
Packages that use optional dependencies must be written to ensure that they can pass their unit tests when the package is not available.
95+
*Optional* dependencies must be added to `manifest.remap`_ to prevent the creation of broken EUPS distrib packages.
96+
Please note that the "self-merge" policy (:jira:`RFC-75`) does not apply to `manifest.remap`_.
97+
Unlike changes merged into `repos.yaml`_, modifications to `manifest.remap`_ do not take immediate affect.
98+
We recommend that you attach the modification PR to a DM Jira issue on the ``Continuous Integration`` component.
9499

95100
.. _github-repository-configuration:
96101

@@ -160,13 +165,6 @@ New :doc:`Git LFS-backed </git/git-lfs>` repos (or existing repos being converte
160165
- At present, the EUPS distrib packaging mechanism does not support LFS-backed repos.
161166
These products **must not** be added to any top-level meta-package or as a mandatory (non-``optional``) recursive dependency of a top-level package.
162167

163-
- *Optional* dependencies must be added to `manifest.remap`_ to prevent the creation of broken EUPS distrib packages.
164-
Please note that the "self-merge" policy (:jira:`RFC-75`) does not apply to `manifest.remap`_.
165-
166-
Unlike changes merged into `repos.yaml`_, modifications to `manifest.remap`_ do not take immediate affect.
167-
168-
We recommend that you attach the modification PR to a DM Jira issue on the ``Continuous Integration`` component.
169-
170168

171169
.. warning::
172170

0 commit comments

Comments
 (0)