Skip to content

Commit

Permalink
docs: add mention of combination_extras matrix member
Browse files Browse the repository at this point in the history
  • Loading branch information
mcyprian committed Apr 30, 2018
1 parent 62a5980 commit 0ab4b3b
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions docs/spec_multispec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,21 @@ Here's an example multispec file::
"2.4":
version: "2.4"
# in the "matrix" section, you can specify combinations that you want
# to explicitly exclude from the rendering matrix
# in the "matrix" section, you can define an action that is
# applied only to specified distro and version combinations
matrix:
exclude:
- distros:
- fedora-26-x86_64
version: "2.2"

combination_extras:
- distros:
- centos-7-x86_64
version: "2.4"
data:
extra_pkgs: ['foo', 'bar']

A multispec has 3 attributes (see below for the explanation of mechanics
behind this file):

Expand All @@ -104,10 +111,16 @@ behind this file):
``distroinfo`` *group* is an exception, as its members ``distros`` list
are used in the cartesian product.

* ``matrix`` (optional) - currently, this attribute can only contain the
``exclude`` member. When used, the ``exclude`` attribute contains a list
of combinations excluded from the matrix. The ``distroinfo`` members
must be referred to via ``distro`` list.
* ``matrix`` (optional) - currently, this attribute can only contain two
members.

* The ``exclude`` attribute contains a list of combinations excluded
from the matrix. The ``distroinfo`` members must be referred to via
``distro`` list.

* The ``combination_extras`` member contains a list of combinations and
extras, mapping of key-value pairs, which are only added to this combination
and can be used in your templates.

Hence the above example produces a following rendering matrix:

Expand Down

0 comments on commit 0ab4b3b

Please sign in to comment.