Skip to content

Commit 8473575

Browse files
committed
describe how to analyze pixi environments
1 parent abf286f commit 8473575

File tree

1 file changed

+61
-4
lines changed

1 file changed

+61
-4
lines changed

README.md

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,11 @@ them to an empty mapping or sequence, respectively:
4242
ignored_violations: []
4343
```
4444

45-
Then add a new step to CI:
45+
Then add a new step to CI.
46+
47+
### conda
48+
49+
To analyze conda environments, simply pass the path to the environment file (`env.yaml`) to the `environments` key.
4650

4751
```yaml
4852
jobs:
@@ -53,7 +57,7 @@ jobs:
5357
- uses: xarray-contrib/minimum-dependency-versions@version
5458
with:
5559
policy: policy.yaml
56-
environment-paths: path/to/env.yaml
60+
environments: path/to/env.yaml
5761
```
5862

5963
To analyze multiple environments at the same time, pass a multi-line string:
@@ -67,8 +71,61 @@ jobs:
6771
6872
- uses: xarray-contrib/minimum-dependency-versions@version
6973
with:
70-
environment-paths: |
74+
environments: |
7175
path/to/env1.yaml
7276
path/to/env2.yaml
73-
path/to/env3.yaml
77+
conda:path/to/env3.yaml # the conda: prefix is optional
78+
```
79+
80+
### pixi
81+
82+
To analyze pixi environments, specify the environment name prefixed with `pixi:` and point to the manifest file using `manifest-path`:
83+
84+
```yaml
85+
jobs:
86+
my-job:
87+
...
88+
steps:
89+
...
90+
91+
- uses: xarray-contrib/minimum-dependency-versions@version
92+
with:
93+
environments: pixi:env1
94+
manifest-path: /path/to/pixi.toml # or pyproject.toml
95+
```
96+
97+
Multiple environments can be analyzed at the same time:
98+
99+
```yaml
100+
jobs:
101+
my-job:
102+
...
103+
steps:
104+
...
105+
106+
- uses: xarray-contrib/minimum-dependency-versions@version
107+
with:
108+
environments: |
109+
pixi:env1
110+
pixi:env2
111+
manifest-path: /path/to/pixi.toml # or pyproject.toml
112+
```
113+
114+
### Mixing environment types
115+
116+
It is even possible to mix environment types (once again, the `conda:` prefix is optional but recommended):
117+
118+
```yaml
119+
jobs:
120+
my-job:
121+
...
122+
steps:
123+
...
124+
125+
- uses: xarray-contrib/minimum-dependency-versions@version
126+
with:
127+
environments: |
128+
pixi:env1
129+
conda:path/to/env.yaml
130+
manifest-path: path/to/pixi.toml # or pyproject.toml
74131
```

0 commit comments

Comments
 (0)