Add option to use GitHub Actions for CI

QUESTIONS.rst

@@ -17,8 +17,9 @@ a description of each of the prompts.
 10. ``edit_on_github_extension``: Set to ``True`` to enable the edit on GitHub sphinx extension.
 11. ``github_project``: This is the GitHub identifier for the edit on GitHub extension and the changelog link extension.
 12. ``use_travis_ci``: If ``'y'`` the template will include an example ``.travis.yml`` file for the Travis CI service.
-13. ``use_read_the_docs``: If ``'y'`` the ``read_the_docs.yml`` and ``.rtd-environment.yml`` files will be included for using conda on Read the Docs.
-14. ``sphinx_theme``: The value of the ``html_theme`` variable in the sphinx configuration file.
-15. ``required_dependencies``: Comma-separated list of required dependencies
-16. ``optional_dependencies``: Comma-separated list of optional dependencies
-17. ``minimum_python_version``: Version string of minimum supported Python version
+13. ``use_gh_actions``: If ``'y'`` the template will include an example ``.github/workflows/tox-tests.yml`` file for the Github Actions CI service.
+14. ``use_read_the_docs``: If ``'y'`` the ``read_the_docs.yml`` and ``.rtd-environment.yml`` files will be included for using conda on Read the Docs.
+15. ``sphinx_theme``: The value of the ``html_theme`` variable in the sphinx configuration file.
+16. ``required_dependencies``: Comma-separated list of required dependencies
+17. ``optional_dependencies``: Comma-separated list of optional dependencies
+18. ``minimum_python_version``: Version string of minimum supported Python version

TEMPLATE_CHANGES.md

@@ -18,6 +18,9 @@ be copied over manually if desired.
 - Refactored the template to follow the recommendations in APE 17:
   https://github.com/astropy/astropy-APEs/blob/master/APE17.rst [#438]
 
+- Add option to use Github Actions for CI.
+
+
 2.1 (unreleased)
 ----------------
 

cookiecutter.json

@@ -11,10 +11,14 @@
     "edit_on_github_extension": "False",
     "github_project": "astropy/astropy",
     "use_travis_ci": "y",
+    "use_gh_actions": "y",
     "use_read_the_docs": "y",
     "sphinx_theme": "astropy-bootstrap",
     "_parent_project": "astropy",
     "required_dependencies": "astropy",
     "optional_dependencies": "",
-    "minimum_python_version": ["3.6", "3.7", "3.8"]
+    "minimum_python_version": ["3.6", "3.7", "3.8"],
+    "_copy_without_render": [
+        ".github"
+    ]
 }

docs/options.rst

@@ -19,6 +19,7 @@ a description of each of the prompts:
 #. ``edit_on_github_extension``: Set to ``True`` to enable the edit on GitHub sphinx extension.
 #. ``github_project``: This is the GitHub identifier for the edit on GitHub extension and the changelog link extension.
 #. ``use_travis_ci``: If ``'y'`` the template will include an example ``.travis.yml`` file for the Travis CI service.
+#. ``use_gh_actions``: If ``'y'`` the template will include an example ``.github/workflows/tox-tests.yml`` file for the Github Actions CI service.
 #. ``use_read_the_docs``: If ``'y'`` the ``read_the_docs.yml`` and ``.rtd-environment.yml`` files will be included for using conda on Read the Docs.
 #. ``sphinx_theme``: The value of the ``html_theme`` variable in the sphinx configuration file.
 #. ``required_dependencies``: Comma-separated list of required dependencies

hooks/post_gen_project.py

@@ -43,6 +43,9 @@ def process_licence(licence_name):
     if '{{ cookiecutter.use_travis_ci }}' != 'y':
         remove_file('.travis.yml')
 
+    if '{{ cookiecutter.use_gh_actions }}' != 'y':
+        remove_dir('.github')
+
     if '{{ cookiecutter.use_read_the_docs }}' != 'y':
         remove_file('.rtd-environment.yml')
         remove_file('readthedocs.yml')

rendered.yml

@@ -12,6 +12,7 @@ default_context:
   edit_on_github_extension: "False"
   github_project: "astropy/astropy"
   use_travis_ci: "y"
+  use_gh_actions: "y"
   use_read_the_docs: "y"
   sphinx_theme: "astropy-bootstrap"
   minimum_python_version: "3.6"

{{ cookiecutter.package_name }}/.github/workflows/tox-tests.yml

@@ -0,0 +1,104 @@
+# GitHub Actions workflow for testing and continuous integration.
+#
+# This file performs testing using tox and tox.ini to define and configure the test environments.
+
+name: Python Tests
+
+on: [push, pull_request]
+
+jobs:
+
+  # Set up matrix to run tox tests across lists of os, python version, and tox environment
+  matrix_tests:
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"  # github actions doesn't yet support this natively so add here
+    strategy:
+      matrix:
+        # Github actions supports ubuntu, windows, and macos virtual environments:
+        # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners
+        #
+        # Only run on ubuntu by default, but can add other os's to the test matrix here.
+        # For example -- os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest]
+
+        # Test python 3.7 and 3.8 by default.
+        python-ver: [7, 8]
+
+        # Specify which tox environments to test in this list.
+        tox-env: [cov, alldeps, devdeps, astropylts]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up python 3.${{ matrix.python-ver }} with tox environment py3${{ matrix.python-ver }}-${{ matrix.tox-env }} on ${{ matrix.os }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.${{ matrix.python-ver }}
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Test with tox
+      run: |
+        tox -e py3${{ matrix.python-ver }}-${{ matrix.tox-env }}
+    #
+    # # This is an example of how to upload coverage to codecov
+    # - name: Upload coverage to codecov
+    #   if: matrix.tox-env == 'cov' && matrix.python-ver == '8'
+    #   uses: codecov/codecov-action@v1
+    #   with:
+    #     token: ${{ secrets.CODECOV }}
+    #     file: ./coverage.xml
+    #     fail_ci_if_error: true
+
+  # Test building of documents
+  doc_build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python to build docs with sphinx
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Testing building of docs using tox
+      run: |
+        tox -e build_docs
+
+  # Test links in documents
+  doc_test:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python to build docs with sphinx
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Check links in docs using tox
+      run: |
+        tox -e linkcheck
+
+  # Perform codestyle check
+  codestyle:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Python codestyle check
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Check codestyle using tox
+      run: |
+        tox -e codestyle

{{ cookiecutter.package_name }}/tox.ini

@@ -43,6 +43,7 @@ description =
 # The following provides some specific pinnings for key packages
 deps =
 
+    cov: coverage
     numpy116: numpy==1.16.*
     numpy117: numpy==1.17.*
     numpy118: numpy==1.18.*
@@ -63,6 +64,7 @@ commands =
     pip freeze
     !cov: pytest --pyargs {{ cookiecutter.module_name }} {toxinidir}/docs {posargs}
     cov: pytest --pyargs {{ cookiecutter.module_name }} {toxinidir}/docs --cov {{ cookiecutter.module_name }} --cov-config={toxinidir}/setup.cfg {posargs}
+    cov: coverage xml -o {toxinidir}/coverage.xml
 
 [testenv:build_docs]
 changedir = docs