[WIP] Add support for GitHub actions

.travis.yml

@@ -10,56 +10,56 @@ matrix:
         - LICENSE=1
         - DEPEND_SOURCE=1
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2  # Travis+Appveyor
     - os: osx
       language: generic
       env:
         - LICENSE=1
         - DEPEND_SOURCE=2
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
     - os: osx
       language: generic
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
     - os: osx
       language: generic
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.7
-        - WINDOWS_CI=2
+        - CI_PROVIDER=1  # Travis only
     - os: osx
       language: generic
       env:
         - LICENSE=1
         - DEPEND_SOURCE=1
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
     - os: osx
       language: generic
       env:
         - LICENSE=1
         - DEPEND_SOURCE=2
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
     - os: osx
       language: generic
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
     - os: osx
       language: generic
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.6
-        - WINDOWS_CI=2
+        - CI_PROVIDER=1
 
     # Pin Xenial for 3.7
     - os: linux
@@ -69,7 +69,7 @@ matrix:
         - LICENSE=1
         - DEPEND_SOURCE=1
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       dist: xenial
@@ -78,7 +78,7 @@ matrix:
         - LICENSE=1
         - DEPEND_SOURCE=2
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       dist: xenial
@@ -87,7 +87,7 @@ matrix:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.7
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       dist: xenial
@@ -96,39 +96,39 @@ matrix:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.7
-        - WINDOWS_CI=2
+        - CI_PROVIDER=1
 
     - os: linux
       python: 3.6
       env:
         - LICENSE=1
         - DEPEND_SOURCE=1
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       python: 3.6
       env:
         - LICENSE=1
         - DEPEND_SOURCE=2
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       python: 3.6
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.6
-        - WINDOWS_CI=1
+        - CI_PROVIDER=2
 
     - os: linux
       python: 3.6
       env:
         - LICENSE=2
         - DEPEND_SOURCE=3
         - PYTHON_VER=3.6
-        - WINDOWS_CI=2
+        - CI_PROVIDER=1
 
 before_install:
     # Make sure pip is around, on OSX Travis we have to do some shenanigans
@@ -138,7 +138,7 @@ before_install:
   - pip install pyyaml cookiecutter
 
     # Build out the cookiecutter from settings
-  - python tests/setup_cookiecutter.py default_project $LICENSE $DEPEND_SOURCE $WINDOWS_CI
+  - python tests/setup_cookiecutter.py default_project $LICENSE $DEPEND_SOURCE $CI_PROVIDER
 
     # Change into new project directory
   - cd default_project

appveyor.yml

@@ -6,21 +6,21 @@ environment:
       DEPEND_SOURCE: 1
       PYTHON_VERSION: "3.6"
       PYTHON_ARCH: "64"
-      WINDOWS: 1
+      CI_PROVIDER: 2  # Travis+Appveyor
 
     - PYTHON: "C:\\Miniconda37-x64"
       LICENSE: 2
       DEPEND_SOURCE: 2
       PYTHON_VERSION: "3.7"
       PYTHON_ARCH: "64"
-      WINDOWS: 1
+      CI_PROVIDER: 2
 
     - PYTHON: "C:\\Python36-x64"
       LICENSE: 1
       DEPEND_SOURCE: 3
       PYTHON_VERSION: "3.6"
       PYTHON_ARCH: "64"
-      WINDOWS: 1
+      CI_PROVIDER: 2
 
 
 
@@ -34,7 +34,7 @@ install:
   - git config --global core.autocrlf true
 
     # Build out the cookiecutter from settings
-  - python tests/setup_cookiecutter.py default_project %LICENSE% %DEPEND_SOURCE% %WINDOWS%
+  - python tests/setup_cookiecutter.py default_project %LICENSE% %DEPEND_SOURCE% %CI_PROVIDER%
 
     # Change into new project directory
   - ps: cd default_project

cookiecutter.json

@@ -5,11 +5,21 @@
     "author_name": "Your name (or your organization/company/team)",
     "author_email": "Your email (or your organization/company/team)",
     "description": "A short description of the project.",
-    "open_source_license": ["MIT", "BSD-3-Clause", "LGPLv3", "Not Open Source"],
+    "open_source_license": [
+        "MIT",
+        "BSD-3-Clause",
+        "LGPLv3",
+        "Not Open Source"
+    ],
     "dependency_source": [
         "Prefer conda-forge over the default anaconda channel with pip fallback",
         "Prefer default anaconda channel with pip fallback",
-        "Dependencies from pip only (no conda)"],
-    "Include_Windows_continuous_integration": ["y","n"],
-    "_cms_cc_version": 1.2
-}
+        "Dependencies from pip only (no conda)"
+    ],
+    "continuous_integration_provider": [
+        "Travis",
+        "Travis+AppVeyor",
+        "GitHub Actions (experimental)"
+    ],
+    "_cms_cc_version": 1.3
+}

hooks/post_gen_project.py

@@ -7,6 +7,7 @@
 
 import os
 import subprocess as sp
+import shutil
 
 
 def decode_string(string):
@@ -58,11 +59,19 @@ def git_init_and_tag():
         print("\ngit repository detected. CookieCutter files have been created in {{ cookiecutter.repo_name }} directory.")
 
 
-def remove_windows_ci():
-    include_windows = '{{ cookiecutter.Include_Windows_continuous_integration }}'
-    if include_windows == "n":
+def select_continuous_integration_provider():
+    provider = '{{ cookiecutter.continuous_integration_provider }}'.lower()
+    if provider == "github actions (experimental)":
         # Remove with appveyor to be a safe delete
         os.remove("appveyor.yml")
+        os.remove(".travis.yml")
+        shutil.rmtree("devtools/travis-ci")
+    elif provider == "travis":
+        shutil.rmtree(".github/workflows")
+        os.remove("appveyor.yml")
+    elif provider == "travis+appveyor":
+        shutil.rmtree(".github/workflows")
+
 
-remove_windows_ci()
+select_continuous_integration_provider()
 git_init_and_tag()

tests/setup_cookiecutter.py

@@ -8,8 +8,8 @@
 project = sys.argv[1]
 lic = sys.argv[2]
 depend = sys.argv[3]
-windows = sys.argv[4]
-print("Options: open_source_license=%s, dependency_source=%s, windows_ci=%s" % (lic, depend, windows))
+provider = sys.argv[4]
+print("Options: open_source_license=%s, dependency_source=%s, ci_provider=%s" % (lic, depend, provider))
 
 # Setup the options
 options = [project, # Repo name
@@ -20,7 +20,7 @@
            "", # Description
            lic, # License
            depend, # Dependency
-           windows] # Windows
+           provider] # ci_provider
 
 # Open a thread
 p = Popen(["cookiecutter", "."], stdin=PIPE, stdout=PIPE)

{{cookiecutter.repo_name}}/.github/workflows/CI.yaml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+    branches:
+      - "master"
+  schedule:
+    # Nightly tests run on master by default:
+    #   Scheduled workflows run on the latest commit on the default or base branch.
+    #   (from https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule)
+    - cron: "0 0 * * *"
+
+jobs:
+  test:
+    name: Test on {{ '${{ matrix.os }}' }}, Python {{ '${{ matrix.python-version }}' }}
+    runs-on: {{ '${{ matrix.os }}' }}
+    strategy:
+      matrix:
+        os: [macOS-latest, ubuntu-latest, windows-latest]
+        python-version: [3.6, 3.7]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Additional info about the build
+      shell: bash
+      run: |
+        uname -a
+        df -h
+        ulimit -a
+
+{% if cookiecutter.dependency_source == 'Dependencies from pip only (no conda)' %}
+    - name: Install testing dependencies
+      shell: bash
+      run: |
+        python -m pip install -U pytest pytest-cov codecov
+{% else %}
+    # More info on options: https://github.com/goanpeca/setup-miniconda
+    - uses: goanpeca/setup-miniconda@v1
+      with:
+        python-version: {{ '${{ matrix.python-version }}' }}
+        environment-file: devtools/conda-envs/test_env.yaml
+{% if cookiecutter.dependency_source == 'Prefer conda-forge over the default anaconda channel with pip fallback' %}
+        channels: conda-forge,defaults
+{% endif %}
+        activate-environment: test
+        auto-update-conda: true
+        auto-activate-base: false
+        show-channel-urls: true
+{% endif %}
+    - name: Install package
+{% if cookiecutter.dependency_source == 'Dependencies from pip only (no conda)' %}
+      shell: bash
+      run: |
+        python -m pip install .
+{% else %}
+      # conda setup requires this special shell
+      shell: bash -l {0}
+      run: |
+        python -m pip install . --no-deps
+        conda list
+{% endif %}
+
+    - name: Run tests
+{% if cookiecutter.dependency_source == 'Dependencies from pip only (no conda)' %}
+      shell: bash
+{% else %}
+      # conda setup requires this special shell
+      shell: bash -l {0}
+{% endif %}
+      run: |
+        pytest -v --cov={{ cookiecutter.repo_name }} --cov-report=xml --color=yes {{ cookiecutter.repo_name }}/tests/
+
+    - name: CodeCov
+      uses: codecov/codecov-action@v1
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-{{ '${{ matrix.os }}' }}-py{{ '${{ matrix.python-version }}' }}

{{cookiecutter.repo_name}}/README.md

@@ -1,12 +1,17 @@
 {{cookiecutter.project_name}}
 ==============================
 [//]: # (Badges)
+{% if cookiecutter.continuous_integration_provider == "GitHub Actions (experimental)" -%}
+[![GitHub Actions Build Status](https://github.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.repo_name}}/workflows/CI/badge.svg)](https://github.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.repo_name}}/actions?query=branch%3Amaster+workflow%3ACI)
+{% elif cookiecutter.continuous_integration_provider == "Travis" -%}
+[![Travis Build Status](https://travis-ci.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}.svg?branch=master)](https://travis-ci.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}})
+{% elif cookiecutter.continuous_integration_provider == "Travis+AppVeyor" -%}
 [![Travis Build Status](https://travis-ci.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}.svg?branch=master)](https://travis-ci.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}})
-{% if cookiecutter.Include_Windows_continuous_integration == "y" -%}
 [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/REPLACE_WITH_APPVEYOR_LINK/branch/master?svg=true)](https://ci.appveyor.com/project/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}/branch/master)
 {% endif -%}
 [![codecov](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}/branch/master/graph/badge.svg)](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}/branch/master)
 
+
 {{cookiecutter.description}}
 
 ### Copyright