aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 943dd6aec5798d5da7e8e9a042fb81013165afd7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# delivery_merge

## What does it do?

1. Install miniconda3 in the current working directory
2. Create a new environment based on an explicit dump file
3. Transpose packages listed in a `dmfile` into the new environment
4. Generate a YAML and explicit dump of the new environment
5. [optionally] Scan packages installed via `dmfile` and execute tests (if possible) inside the new environment

## Where should I run this?

Inside of a CI/CD pipeline.


## Usage

```
usage: delivery_merge [-h] [--env-name ENV_NAME] --installer-version
                      INSTALLER_VERSION [--run-tests] --dmfile DMFILE
                      base_spec

positional arguments:
  base_spec

optional arguments:
  -h, --help            show this help message and exit
  --env-name ENV_NAME   name of environment
  --installer-version INSTALLER_VERSION
                        miniconda3 installer version
  --run-tests
  --dmfile DMFILE
```

## The dmfile

Comment characters: `;` or `#`

Line format: `{conda_package}[=<>]{version}`

**Example:**

```
; This is a comment
package_a=1.0.0
package_b<=1.0.0
package_c>=1.0.0  # This is also a comment
package_d>1.0.0
package_e<1.0.0
```


## Execution example

```sh
$ cat < EOF > hstdp-2019.3-py36.dm
python=3.6
numpy=1.16.3
EOF
$ git clone https://github.com/astroconda/astroconda-releases
$ delivery_merge --env-name delivery \
    --installer-version=4.5.12 \
    --dmfile hstdp-2019.3-py36.dm \
    astroconda-releases/hstdp/2019.2/latest-linux

# >>> Actual output here <<<
```