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.

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

documenting local runs better #1590

Merged
merged 13 commits into from
Feb 1, 2022
2 changes: 2 additions & 0 deletions .ci_scripts/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ dependencies:
# uncomment to restore search
# - elm
# - nodejs
# - pip:
# - sphinxcontrib-newsfeed # this helps when using vscode locally
25 changes: 14 additions & 11 deletions src/maintainer/adding_pkgs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -635,20 +635,23 @@ Running tests locally for staged recipes

If you want to run and build packages in the staged-recipes repository locally,
go to the root repository directory and run the
``.scripts/run_docker_build.sh`` script. This requires that you have docker
installed on your machine.
``build-locally.py`` script (you need Python 3). And then you could follow the prompt to select the variant you'd like to build. This requires that you have Docker
installed on your machine if you are building a package for Linux.
For MacOS, it will prompt you to select a location for the SDK (e.g. ``export OSX_SDK_DIR=/opt``) to be downloaded.

You need to define an environment variable named ``CONFIG``. Its value must be
the name of one of the three YAML configuration files in the ``.ci_support``
directory (either ``linux64``, ``osx64``, or ``win64``). As an example, you can
invoke the command as follows.

.. code-block:: sh
.. code-block:: bash

$ cd ~/staged-recipes
$ python build-locally.py

$ cd staged-recipes
$ CONFIG=linux64 ./.scripts/run_docker_build.sh
If you know which image you want to build, you can specify it as an argument to the script.

Once built, you can find the finished package under ``staged-recipes/build_artifacts``.
.. code-block:: bash

$ cd ~/staged-recipes
$ python build-locally.py <VARIANT>

where ``<VARIANT>`` is one of the file names in the ``.ci_support/`` directory, e.g. ``linux64``, ``osx64``, and ``linux64_cuda102``.


About
Expand Down