Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions about adding package to pipelines.lsst.io #491

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add instructions about adding package to pipelines.lsst.io #491

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions stack/adding-a-new-package.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ The new package then needs to be added to the :file:`ups/*.table` file (and poss
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.
Packages that use optional dependencies must be written to ensure that they can pass their unit tests when the package is not available.

The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily.
Finally, if the package is part of the LSST Science Pipelines, you should include it in the Pipelines documentation, https://pipelines.lsst.io.
See :doc:`/stack/add-a-package-to-pipelines-lsst-io` for instructions.


.. _github-repository-configuration:

Configuring GitHub Repositories
Expand Down Expand Up @@ -113,6 +115,7 @@ New :doc:`Git LFS-backed </git/git-lfs>` repos (or existing repos being converte

.. _LSST organization on GitHub: https://github.com/lsst
.. _lsst/templates: https://github.com/lsst/templates/tree/master/project_templates/stack_package
.. _lsst/pipelines_lsst_io: https://github.com/lsst/pipelines_lsst_io/blob/master/ups/pipelines_lsst_io.table
.. _Distributing third-party packages with EUPS: https://confluence.lsstcorp.org/display/LDMDG/Distributing+third-party+packages+with+EUPS
.. _etc/repos.yaml file in the lsst/repos repository: https://github.com/lsst/repos/blob/master/etc/repos.yaml
.. _repos.yaml: https://github.com/lsst/repos/blob/master/etc/repos.yaml
Expand Down