Skip to content

Commit 4773a5b

Browse files
committed
Add docs for GHA self-hosted settings
1 parent 0ba1bc2 commit 4773a5b

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

src/maintainer/conda_forge_yml.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Top-level fields
3737
* :ref:`conda_solver`
3838
* :ref:`docker`
3939
* :ref:`github`
40+
* :ref:`github_actions`
4041
* :ref:`idle_timeout_minutes`
4142
* :ref:`linux`
4243
* :ref:`linux_aarch64`
@@ -353,6 +354,50 @@ defaults are as follows:
353354
# conda-forge-ci-setup-feedstock references
354355
tooling_branch_name: main
355356
357+
.. _github_actions:
358+
359+
github_actions
360+
--------------
361+
This dictates the behavior of the Github Actions CI service. It is a
362+
mapping for GHA-specific configuration options. For example:
363+
364+
.. code-block:: yaml
365+
366+
github_actions:
367+
# Is the job using Microsoft hosted free runners or 'self-hosted'.
368+
self_hosted: false
369+
# triggers for actions. Defaults to `['push', 'pull_request']` for
370+
# Microsoft hosted free runners and `['push']` for self-hosted
371+
triggers: []
372+
# Timeout for CI jobs
373+
timeout_minutes: 360
374+
# Cancel in progress builds. Defaults to false for Microsoft hosted
375+
# free runner and true for self-hosted
376+
cancel_in_progress: None
377+
# Maximum number of parallel jobs per build.
378+
max_parallel: None
379+
# Retain build artifacts for inspection
380+
store_build_artifacts: false
381+
# Retention period for built artifacts
382+
artifact_retention_days: 14
383+
384+
For self-hosted runners ``recipe/conda_build_config.yaml`` is used for
385+
specifying labels for the runners.
386+
387+
.. code-block:: yaml
388+
389+
github_actions_labels:
390+
# use Microsoft free runners
391+
- hosted # [osx or win]
392+
# Use self-hosted runner with custom label
393+
- - self-hosted # [linux and aarch64]
394+
- custom-label # [linux and aarch64]
395+
# Use self-hosted runner from cirun
396+
- cirun-openstack-cpu-large # [linux and ppc64le]
397+
# Use self-hosted gpu runner from cirun
398+
- cirun-openstack-gpu-large # [linux and x86_64]
399+
400+
356401
.. _idle_timeout_minutes:
357402

358403
idle_timeout_minutes

0 commit comments

Comments
 (0)