# github Actions yml file draft

## Resources

- [Django CMS Test Matrix](https://docs.google.com/spreadsheets/d/1oRK9o7yrhUsO7YcRTv4x15VDVQVGGbEghClztofYEgI/edit?usp=sharing)
- Vinit PR: https://github.com/django-cms/django-cms/pull/6993
- Wagtail example: https://github.com/wagtail/wagtail/blob/main/.github/workflows/test.yml
- Django CMS Travis: https://github.com/django-cms/django-cms/blob/develop/.travis.yml
- Django Actions: https://github.com/django/django/blob/main/.github/workflows/linters.yml

## Instructions
- Fork the django-cms project, configure GithubActions in your fork and point the GH Actions to your branch.
- Using Vinits example will get the workflow running for one Python and Django instance using Postgres.
- Using the Matrix we need to create a job for each of the following:
- frontend
- docs
- database-postgres
- database-mysql
- database-sqlite
- Beware: there are tests in travis.yml that test if the project runs if a custom user model is specified.
- AUTH_USER_MODEL='emailuserapp.EmailUser'
- this used to be done via env variables in travis - need to check if this is possible in github actions
- separate job with custom reduced matrix

### Approach
- different requirements.txt with different django and django CMS

## draft based on vinits merge request

this file will be named backend.txt inside .github/workflows/

name: Python package

on: [push]

jobs:
  database-postgres:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.7, 3.8, 3.9,]  # latest release minus two
        requirements-file: [
            django-2.2.txt,
            django-3.0.txt,
            django-3.1.txt,
        ]
        os: [
          ubuntu-20.04,
        ]
        
    services:
      postgres:
        image: postgres:12
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
          POSTGRES_DB: postgres
        ports:
          - 5432:5432
        # needed because the postgres container does not provide a healthcheck
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

    steps:
    - uses: actions/checkout@v1
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        sudo apt install gettext gcc -y
        python -m pip install --upgrade pip
        pip install pytest
        pip install -r test_requirements/${{ matrix.requirements-file }}
        python setup.py install
    - name: Test with pytest
      run: |
        # check actual test command in .travis.yml
        python manage.py test
        
        
flake8:
   # use separate file .github/workflows/linters.yml
   # check https://github.com/django/django/blob/main/.github/workflows/linters.yml
   # no database required
   # open question: tox anywhere?
   - name: Lint with flake8
     run: |
        pip install flake8
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics


database-mysql:
   # add mysql service
   pass

database-sqlite:
   # add sqlite package for python
   pass
   
   
frontend:
   # make separate file frontend.txt
   # travis config gives a good idea of what frontend does. Basically copy over
   pass
   
docs:
   # make separate docs.txt just as https://github.com/wagtail/wagtail/blob/main/.github/workflows/docs.yml
   # with sqlite
   # copy over from travis
   pass