Merge pull request #41 from saimn/actions

Setup publish and tests on Actions

Author: saimn

.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  pull_request:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    if: github.repository == 'astropy/pytest-doctestplus'
+    if: (github.repository == 'astropy/sphinx-astropy' && (github.event_name == 'tags' || contains(github.event.pull_request.labels.*.name, 'Build wheels')))
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install python-build and twine
+      run: python -m pip install build "twine>=3.3"
+
+    - name: Build package
+      run: python -m build --sdist --wheel .
+
+    - name: List result
+      run: ls -l dist
+
+    - name: Check long_description
+      run: python -m twine check --strict dist/*
+
+    - name: Test package
+      run: |
+        cd ..
+        python -m venv testenv
+        testenv/bin/pip install pytest sphinx-astropy/dist/*.whl
+        testenv/bin/pytest sphinx-astropy/tests
+
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_password }}

.github/workflows/python-tests.yml

@@ -0,0 +1,64 @@
+name: Run unit tests
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+    tags:
+  workflow_dispatch:
+  schedule:
+    # Run every Sunday at 03:53 UTC
+    - cron: 53 2 * * 0
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: 3.7
+            toxenv: py36-test-sphinx17
+          - os: windows-latest
+            python-version: 3.7
+            toxenv: py36-test-sphinx18
+          - os: macos-latest
+            python-version: 3.7
+            toxenv: py37-test-sphinx20
+          - os: ubuntu-latest
+            python-version: 3.8
+            toxenv: py37-test-sphinx24
+          - os: windows-latest
+            python-version: 3.8
+            toxenv: py38-test-sphinx30
+          - os: ubuntu-latest
+            python-version: 3.9
+            toxenv: py38-test-sphinx35
+          - os: ubuntu-latest
+            python-version: 3.9
+            toxenv: py39-test-sphinx40
+          - os: macos-latest
+            python-version: 3.9
+            toxenv: py38-test-sphinxdev
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Tox
+      run: python -m pip install tox
+    - name: Run Tox
+      run: tox -v -e ${{ matrix.toxenv }}
+
+    # - name: Slack Notification
+    #   uses: 8398a7/action-slack@v3
+    #   with:
+    #     status: ${{ job.status }}
+    #   env:
+    #     SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
+    #   if: always() # TODO: cron

tox.ini

@@ -0,0 +1,32 @@
+[tox]
+envlist =
+    py{37,38,39}-test
+    codestyle
+requires =
+    setuptools >= 30.3.0
+    pip >= 19.3.1
+isolated_build = true
+
+[testenv]
+changedir = .tmp/{envname}
+description = run tests
+deps =
+    sphinx17: sphinx==1.7.*
+    sphinx18: sphinx==1.8.*
+    sphinx20: sphinx==2.0.*
+    sphinx24: sphinx==2.4.*
+    sphinx30: sphinx==3.0.*
+    sphinx35: sphinx==3.5.*
+    sphinx40: sphinx==4.0.*
+    sphinxdev: git+https://github.com/sphinx-doc/sphinx#egg=sphinx
+
+commands =
+    pip freeze
+    pytest {toxinidir}/tests {posargs}
+
+[testenv:codestyle]
+changedir =
+skip_install = true
+description = check code style, e.g. with flake8
+deps = flake8
+commands = flake8 sphinx_astropy --count