How to access matrix variables in Github actions

Question

I've set up a Github workflow for my CI needs, and it seems to somehow reset values assigned to matrix variables to an empty string whenever I do a comparison using matrix values e.g

if: matrix.python-version == '3.8' && matrix.toxenv=='quality'

and I've specified runs-on: ${{ matrix.os }} it fails saying:

Error when evaluating 'runs-on' for job 'run_tests'. (Line: 12, Col: 14): Unexpected value ''

if I specify runs-on: ubuntu-20.04 it works just fine.

complete Github workflow: (I've setup TOXENV environment variables so it runs a new job for each tox environment in parallel, and to avoid unnecessary builds running with every job (e.g quality) and slowing down the jobs)

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  run_tests:
    name: Tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-20.04]
        python-version: ['3.5', '3.8', '3.9']
        toxenv: ['django22', 'django30','django31']
        include:
          - python-version: "3.8"
            toxenv: "quality"
        exclude:
          - python-version: "3.5"
            toxenv: "django30"
          - python-version: "3.5"
            toxenv: "django31"

    steps:
    - uses: actions/checkout@v2
    - name: setup python
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install pip
      run: pip install -r requirements/pip.txt

    - name: Install Dependencies
      run: pip install -r requirements/ci.txt

    - name: Run Tests
      env:
        TOXENV: python${{ matrix.python-version }}-${{ matrix.toxenv }}
      run: tox

    # it'll run a separate job for quality checks with python 3.8
    - name: Run Quality
      if: matrix.python-version == '3.8' && matrix.toxenv=='quality'
      env:
        TOXENV: ${{ matrix.toxenv }}
      run: tox

    - name: Run Coverage
      if: matrix.python-version == '3.8' && matrix.toxenv=='django22'
      uses: codecov/codecov-action@v1
      with:
        flags: unittests
        fail_ci_if_error: true

Krzysztof Madej · Accepted Answer · 2020-11-30 02:18:50Z

5

The issue is related to your include section. I don't know why but here you must define fully for which combination you want to add another configuration. This syntax would work:

jobs:
  run_tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-20.04]
        python-version: ['3.5', '3.8', '3.9']
        toxenv: ['django22', 'django30','django31']
        include:
          - python-version: '3.8'
            toxenv: 'quality'
            os: [ubuntu-20.04]
        exclude:
          - python-version: '3.5'
            toxenv: 'django30'
          - python-version: '3.5'
            toxenv: 'django31'
    steps:
    - name: Get color
      run: echo "${{ matrix.os }} - ${{ matrix.python-version }} - ${{ matrix.toxenv }}"

answered Nov 30, 2020 at 2:18

Krzysztof Madej

42.1k10 gold badges117 silver badges141 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Aarif Over a year ago

so any configuration we add in include section should contain all the key/values otherwise it would be set to an empty string for which we didn't mention any value?

Aarif Over a year ago

just tested this, it works! thank you, and the assumption I made above is right we've to specify all the key/values for matrix in include section that we would normally specify.

Krzysztof Madej Over a year ago

Yeah, I found it too. Is strange but it works :)

Collectives™ on Stack Overflow

How to access matrix variables in Github actions

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related