Add more docs to explain details and fix #99

Fixes #99 where the extra env variables exposed via
recipe_append.yaml are no longer exposed.

bob/devtools/bootstrap.py

@@ -525,6 +525,7 @@ if __name__ == "__main__":
                 )
             )
 
+    # These are the same versions as in bob.devtools/conda/meta.yaml
     conda_version = "4"
     conda_build_version = "3"
     mamba_version = "0.23"

bob/devtools/build.py

@@ -452,17 +452,20 @@ def conda_create(conda, name, overwrite, condarc, packages, dry_run, use_local):
 def get_docserver_setup(public, stable, server, intranet, group):
     """Returns a setup for BOB_DOCUMENTATION_SERVER.
 
+    BOB_DOCUMENTATION_SERVER is used in bob.extension.utils.link_documentation
+    to find the links of the documentation of Bob packages. The initial servers in
+    the output servers list have higher priority.
+
     What is available to build the documentation depends on the setup of
     ``public`` and ``stable``:
 
-    * public and stable: only returns the public stable channel(s)
-    * public and not stable: returns both public stable and beta channels
-    * not public and stable: returns both public and private stable channels
-    * not public and not stable: returns all channels
-
-    Beta channels have priority over stable channels, if returned.  Private
-    channels have priority over public channles, if turned.
+    * public and stable: only returns the public stable folder
+    * public and not stable: only returns the public beta folder
+    * not public and stable: returns public and private stable folders
+    * not public and not stable: returns public and private beta folders
 
+    If returned, Priavte channels have **lower** priority over public channles
+    because, private packages become public eventually.
 
     Args:
 
@@ -473,7 +476,8 @@ def get_docserver_setup(public, stable, server, intranet, group):
       server: The base address of the server containing our conda channels
       intranet: Boolean indicating if we should add "private"/"public" prefixes
         on the returned paths
-      group: The group of packages (gitlab namespace) the package we're compiling
+      group: The group of packages (gitlab namespace) the package we're
+      compiling
         is part of.  Values should match URL namespaces currently available on
         our internal webserver.  Currently, only "bob" or "beat" will work.
 
@@ -493,6 +497,7 @@ def get_docserver_setup(public, stable, server, intranet, group):
 
     # public documentation: always can access
     prefix = "/software/%s" % group
+
     if stable:
         entries += [
             server + prefix + "/docs/" + group + "/%(name)s/%(version)s/",

bob/devtools/data/conda_build_config.yaml

+# Make sure this file is up-to-date with:
+# https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/main/recipe/conda_build_config.yaml
+
 # This differs from target_platform in that it determines what subdir the compiler
 #    will target, not what subdir the compiler package will be itself.
 #    For example, we need a win-64 vs2008_win-32 package, so that we compile win-32

bob/devtools/data/gitlab-ci/single-package.yaml

@@ -54,6 +54,8 @@ stages:
   tags:
     - bob
     - docker
+  # make sure we use the same image as conda-forge:
+  # https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/main/recipe/conda_build_config.yaml
   image: quay.io/condaforge/linux-anvil-cos7-x86_64
   artifacts:
     paths:

bob/devtools/data/recipe_append.yaml

-build:
-  script_env:
-    - DOCSERVER
-    - NOSE_EVAL_ATTR
-    - PYTEST_ADDOPTS
-
+# Because we want to use centos 7
+# https://conda-forge.org/docs/maintainer/knowledge_base.html#using-centos-7
 requirements:  # [linux64]
   build:  # [linux64]
     - sysroot_linux-64 2.17  # [linux64]

conda/meta.yaml

@@ -31,6 +31,8 @@ requirements:
     - black >=19
     - click >=7
     - click-plugins
+    # conda, conda-build, mamba, boa versions below are the same versions as in
+    # bob.devtools/bob/devtools/bootstrap.py
     - conda=4
     - conda-build=3
     - mamba=0.23

conda/recipe_append.yaml

-build:
-  script_env:
-    - DOCSERVER
-    - NOSE_EVAL_ATTR
-    - PYTEST_ADDOPTS