Merge pull request #53 from lsst-ts/tickets/DM-39090

Deprecate conda guide, point to setup conda with CI page
lsst-ts · Jun 21, 2023 · f3adfc4 · f3adfc4
2 parents 7567216 + 187208d
commit f3adfc4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 26 deletions.
diff --git a/doc/guidelines/conda/conda.rst b/doc/guidelines/conda/conda.rst
@@ -4,9 +4,10 @@
 Conda Developer Guide
 =====================
 
-.. note::
+.. warning::
 
-   This document contains a developer guide for conda and Telescope Site Software.
+   This page is deprecated.
+   Please use :ref:`Conda-Jenkinsfile` instead.
 
 
 Procedure

diff --git a/doc/guidelines/conda/jenkins-conda.rst b/doc/guidelines/conda/jenkins-conda.rst
@@ -1,13 +1,12 @@
 .. _Conda-Jenkinsfile:
 
-#################
-Conda Jenkinsfile
-#################
+#######################
+Setup Conda for Jenkins
+#######################
 
-The purpose of this document is to make a how-to for having a conda package build on CI.
+The purpose of this document is to make a how-to for having a conda package build on Jenkins.
 This document includes templates for accomplishing this goal.
 The first step is to create a conda recipe for a CSC.
-The :doc:`conda development guide <./conda>` will be helpful.
 A template for doing so has been included on this page.
 
 
@@ -19,6 +18,7 @@ Then touch a :file:`meta.yaml` file inside of the ``conda`` folder.
 Change the ``csc-name`` so that it becomes the name of the csc.
 Another thing is to change requirements so that they match the CSC's.
 Keep in mind that the test requirements need to include test framework dependencies.
+It is suggested to sort dependencies as that increases readability of the recipe.
 Also to find the configuration repo, look for the :meth:`get_config_pkg` in the CSC class.
 
 .. literalinclude:: ./meta.yaml.template

diff --git a/doc/guidelines/conda/meta.yaml.template b/doc/guidelines/conda/meta.yaml.template
@@ -9,46 +9,34 @@ source:
 build:
     noarch: python
     script: {{ PYTHON }} -m pip install --no-deps --ignore-installed .
-    script_env:
-        - PATH
-        - PYTHONPATH
-        - LD_LIBRARY_PATH
-        - OSPL_HOME
-        - PYTHON_BUILD_VERSION
-        - PYTHON_BUILD_LOCATION
-        - LSST_DDS_DOMAIN
-        # Replace with csc configuration repo directory, i.e. TS_CONFIG_ATTCS_DIR for athexapod
 
 test:
     requires:
-        - ts-conda-build
-        - ts-dds
+        - ts-conda-build =0.3
         - ts-idl {{ idl_version }}
         - ts-salobj {{ salobj_version }}
     source_files:
-        - python
         - bin
-        - tests
-        - schema
         - pyproject.toml
+        - python
+        - tests
     commands:
         - pytest
 
 requirements:
     host:
         - python {{ python }}
-        - pip
-        - setuptools_scm
         - setuptools
-        - pytest-runner
+        - setuptools_scm
     build:
         - python {{ python }}
-        - setuptools_scm
         - setuptools
+        - setuptools_scm
         - ts-conda-build =0.3
     run:
         - python {{ python }}
         - setuptools
         - setuptools_scm
-        - ts-salobj
         - ts-idl
+        - ts-salobj
+        # Add any other runtime dependencies here