Skip to content

Commit d240123

Browse files
Updated conda_forge_yml.rst
1 parent 2843194 commit d240123

File tree

1 file changed

+71
-27
lines changed

1 file changed

+71
-27
lines changed

src/maintainer/conda_forge_yml.rst

Lines changed: 71 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,34 @@ upload packages to anaconda.org, which can be useful for testing. For example:
2121
Top-level fields
2222
================
2323

24-
* appveyor
25-
* azure
26-
* build_platform
27-
* bot
28-
* channel_priority
29-
* channels
30-
* choco
31-
* circle
32-
* conda_forge_output_validation
33-
* docker
34-
* github
35-
* idle_timeout_minutes
36-
* linux
37-
* linux_aarch64
38-
* linux_ppc64le
39-
* os_version
40-
* osx
41-
* provider
42-
* recipe_dir
43-
* remote_ci_setup
44-
* skip_render
45-
* templates
46-
* test_on_native_only
47-
* travis
48-
* upload_on_branch
49-
* win
50-
24+
* :ref:`appveyor`
25+
* :ref:`azure-config`
26+
* :ref:`build_platform`
27+
* :ref:`bot`
28+
* :ref:`channel_priority`
29+
* :ref:`channels`
30+
* :ref:`choco`
31+
* :ref:`circle`
32+
* :ref:`conda_forge_output_validation`
33+
* :ref:`docker`
34+
* :ref:`github`
35+
* :ref:`idle_timeout_minutes`
36+
* :ref:`linux`
37+
* :ref:`linux_aarch64`
38+
* :ref:`linux_ppc64le`
39+
* :ref:`os_version`
40+
* :ref:`osx`
41+
* :ref:`provider`
42+
* :ref:`recipe_dir`
43+
* :ref:`remote_ci_setup`
44+
* :ref:`skip_render`
45+
* :ref:`templates`
46+
* :ref:`test_on_native_only`
47+
* :ref:`travis`
48+
* :ref:`upload_on_branch`
49+
* :ref:`win`
50+
51+
.. _appveyor:
5152

5253
appveyor
5354
--------
@@ -78,6 +79,8 @@ mapping for Azure-specific configuration options. For example:
7879
# built packages) as an Azure pipeline artifact that can be downloaded
7980
store_build_artifacts: False
8081
82+
.. _bot:
83+
8184
bot
8285
---
8386
This field controls the behavior of the ``auto-tick`` bot which issues
@@ -101,6 +104,8 @@ automatic version updates/migrations for feedstocks. The current options are
101104
abi_migration_branches:
102105
- v1.10.x
103106
107+
.. _build_platform:
108+
104109
build_platform
105110
--------------
106111
This is a mapping from the build platform to the host platform of the package
@@ -112,13 +117,17 @@ build platform using cross-compiling.
112117
build_platform:
113118
osx_64: linux_64
114119
120+
.. _channel_priority:
121+
115122
channel_priority
116123
----------------
117124

118125
This value sets the ``conda`` solver channel priority for feedstock builds.
119126
The default is ``strict``. Any valid value for the same setting in the ``.condarc`` is
120127
allowed here.
121128

129+
.. _channels:
130+
122131
channels
123132
--------
124133
This represents the channels to grab packages from during builds and
@@ -138,6 +147,7 @@ has been built. The ``channels`` variable is a mapping with
138147
targets:
139148
- ["conda-forge", "main"]
140149
150+
.. _choco:
141151

142152
choco
143153
-----
@@ -158,6 +168,8 @@ This is currently only implemented for Azure Pipelines. The command that is run
158168
``choco install {entry} -fdv -y --debug``. That is, ``choco install`` is executed
159169
with a standard set of additional flags that are useful on CI.
160170

171+
.. _circle:
172+
161173
circle
162174
--------
163175
The top-level ``circle`` key specifies configurations for the Circle
@@ -171,13 +183,17 @@ modified. Tools like conda-smithy may modify this, as need. It has a single
171183
secure:
172184
BINSTAR_TOKEN: <some big hash>
173185
186+
.. _conda_forge_output_validation:
187+
174188
conda_forge_output_validation
175189
-----------------------------
176190

177191
This field must be set to ``True`` for feedstocks in the ``conda-forge`` GitHub
178192
organization. It enables the required feedstock artifact validation as described
179193
in :ref:`output_validation`.
180194

195+
.. _docker:
196+
181197
docker
182198
------
183199
This is a mapping to docker configuration options. These are relatively
@@ -191,6 +207,8 @@ self-explanatory. The defaults are as follows:
191207
command: "bash"
192208
interactive: True
193209
210+
.. _github:
211+
194212
github
195213
------
196214
This is mapping of configuration variables for GitHub. The
@@ -206,6 +224,7 @@ defaults are as follows:
206224
# branch name to execute on
207225
branch_name: master
208226
227+
.. _idle_timeout_minutes:
209228

210229
idle_timeout_minutes
211230
--------------------
@@ -216,6 +235,7 @@ don't have chatty enough builds. Currently only implemented in Travis and Circle
216235
217236
idle_timeout_minutes: 60
218237
238+
.. _linux:
219239

220240
linux
221241
-----
@@ -227,6 +247,7 @@ Currently only:
227247
linux:
228248
enabled: False
229249
250+
.. _linux_aarch64:
230251

231252
linux_aarch64
232253
-------------
@@ -238,6 +259,7 @@ Currently only:
238259
linux_aarch64:
239260
enabled: False
240261
262+
.. _linux_ppc64le:
241263

242264
linux_ppc64le
243265
-------------
@@ -249,6 +271,8 @@ Currently only:
249271
linux_ppc64le:
250272
enabled: False
251273
274+
.. _os_version:
275+
252276
os_version
253277
----------
254278
This key is used to set the OS versions for ``linux_*`` platforms. Valid entries map a linux platform and arch to either ``cos6``
@@ -259,6 +283,8 @@ or ``cos7``. Currently ``cos6`` is the default for ``linux-64``. All other linux
259283
os_version:
260284
linux_64: cos7
261285
286+
.. _osx:
287+
262288
osx
263289
---
264290
The macOSX-specific configuration options. This is largely an internal setting.
@@ -269,6 +295,8 @@ Currently only:
269295
osx:
270296
enabled: False
271297
298+
.. _provider:
299+
272300
provider
273301
--------
274302
The ``provider`` field is a mapping from arch (operating system) to CI service.
@@ -319,6 +347,8 @@ To enable ``linux_ppc64le`` and ``linux_aarch64`` and the following:
319347
linux_ppc64le: default
320348
linux_aarch64: default
321349
350+
.. _recipe_dir:
351+
322352
recipe_dir
323353
----------
324354
The relative path to the recipe directory. The default is:
@@ -327,6 +357,8 @@ The relative path to the recipe directory. The default is:
327357
328358
recipe_dir: recipe
329359
360+
.. _remote_ci_setup:
361+
330362
remote_ci_setup
331363
---------------
332364
This option can be used to override the default ``conda-forge-ci-setup`` package.
@@ -337,6 +369,8 @@ channel_alias if no prefix given.
337369
338370
remote_ci_setup: "conda-forge-ci-setup=3"
339371
372+
.. _skip_render:
373+
340374
skip_render
341375
-----------
342376
This option specifies a list of files which conda smithy will skip rendering.
@@ -350,11 +384,15 @@ For example, if you want to customize .gitignore and LICENSE.txt file by your ow
350384
- .gitignore
351385
- LICENSE.txt
352386
387+
.. _templates:
388+
353389
templates
354390
---------
355391
This is mostly an internal field for specifying where templates files live.
356392
You shouldn't need it.
357393

394+
.. _test_on_native_only:
395+
358396
test_on_native_only
359397
-------------------
360398
This is used for disabling testing for cross compiling. Default is ``false``
@@ -363,6 +401,8 @@ This is used for disabling testing for cross compiling. Default is ``false``
363401
364402
test_on_native_only: True
365403
404+
.. _travis:
405+
366406
travis
367407
------
368408
The top-level ``travis`` key specifies configurations for the Travis
@@ -376,6 +416,8 @@ modified. Tools like conda-smithy may modify this, as need. It has a single
376416
secure:
377417
BINSTAR_TOKEN: <some big hash>
378418
419+
.. _upload_on_branch:
420+
379421
upload_on_branch
380422
----------------
381423
This parameter restricts uploading access on work from certain branches of the
@@ -388,6 +430,8 @@ master branch:
388430
389431
upload_on_branch: master
390432
433+
.. _win:
434+
391435
win
392436
---
393437
The Windows-specific configuration options. This is largely an internal setting.

0 commit comments

Comments
 (0)