refactor readme files: in conda tests

pull/1188/head
Erik Sundell 2022-10-16 11:03:24 +02:00
rodzic 6e89647dbc
commit 3ea45d1258
6 zmienionych plików z 19 dodań i 13 usunięć

Wyświetl plik

@ -1,11 +1,21 @@
# Overview of tests for the conda buildpack
## py2
## Tested configuration files
- [`.binder/`](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
- [`requirements.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#requirements-txt-install-a-python-environment)
- [`postBuild](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
## Tested repo2docker command line flags
- [`--target-repo-dir`](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
### py2
- Test setup of a Python 2 environment by declaring `python=2` in
`environment.yml`.
## py35-binder-dir
### py35-binder-dir
- Test setup of a Python 3.5 environment by declaring `python=3.5` in
`environment.yml`.
@ -14,11 +24,9 @@
Python 3 supported by repo2docker's conda buildpack. See
`repo2docker/buildpacks/conda` for details.
- Test use of a `.binder` directory, where files outside it shouldn't be
considered. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
for details.
- Test use of a `.binder` directory.
## py310-requirements-file
### py310-requirements-file
- Test setup of a Python 3.10 environment by declaring `python=3.10` in
`environment.yml`.
@ -30,7 +38,7 @@
- Test use of a `requirements.txt` file, where an `environment.yml` file should
take precedence and the `requirements.txt` should be ignored.
## r-postbuild-file
### py-r-postbuild-file
- Test setup of the default Python environment by omitting `python` from
`environment.yml` file.
@ -38,16 +46,14 @@
- Test setup of the default R environment by specifying `r-base` in
`environment.yml`.
- Test use of a `postBuild` file. See [this documentation](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
for details.
- Test use of a `postBuild` file.
## r3.6-target-repo-dir-flag
### r3.6-target-repo-dir-flag
- Test setup of a R 3.6 environment by specifying `r-base=3.6` in
`environment.yml`.
- Test use of repo2docker with the `--target-repo-dir` flag. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
for details.
- Test use of repo2docker with the `--target-repo-dir` flag.
`--target-repo-dir` is meant to support custom paths where repositories can be
copied to besides `${HOME}`.

Wyświetl plik

@ -1,4 +1,4 @@
# This file is respected by repo2docker's test suite, but not repo2docker
# itself. It is used solely to help us test command line flags.
# itself. It is used solely to help us test repo2docker's command line flags.
#
- --target-repo-dir=/srv/repo