Skip to content

Commit dbb9b8f

Browse files
authored
Merge pull request #40 from Chilipp/github-actions
create CI github workflow
2 parents 1b5cacd + 30c3abc commit dbb9b8f

File tree

4 files changed

+55
-48
lines changed

4 files changed

+55
-48
lines changed

.github/workflows/python-app.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# This workflow will install Python dependencies, run tests and lint with a single version of Python
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Tests
5+
6+
on:
7+
push:
8+
pull_request:
9+
10+
jobs:
11+
build:
12+
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
matrix:
17+
python-version: [3.5, 3.6, 3.7, 3.8]
18+
sphinx-version: ["", "3.2.*", "3.1.*", "3.0.*", "2.4.*", "2.3.*", "2.2.*"]
19+
20+
steps:
21+
- uses: actions/checkout@v2
22+
- name: Set up Python ${{ matrix.python-version }}
23+
uses: actions/setup-python@v2
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
- name: Display Python version
27+
run: python -c "import sys; print(sys.version)"
28+
- name: Install dependencies
29+
env:
30+
SPHINX_VERSION: ${{ matrix.sphinx-version }}
31+
run: |
32+
python -m pip install --upgrade pip
33+
SPHINX=sphinx
34+
if [[ $SPHINX_VERSION != "" ]]; then
35+
SPHINX="${SPHINX}==${SPHINX_VERSION}";
36+
fi
37+
pip install pytest pytest-cov codecov "${SPHINX}" sphinx-testing .
38+
- name: Test with pytest
39+
run: |
40+
pytest --cov=autodocsumm --cov-report=xml
41+
codecov

.travis.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ Extending your autodoc API docs with a summary
1111
* - docs
1212
- |docs|
1313
* - tests
14-
- |travis| |requires| |coveralls|
14+
- |github-action| |requires| |codecov|
1515
* - package
1616
- |version| |supported-versions| |supported-implementations|
1717

1818
.. |docs| image:: http://readthedocs.org/projects/autodocsumm/badge/?version=latest
1919
:alt: Documentation Status
2020
:target: http://autodocsumm.readthedocs.io/en/latest/?badge=latest
2121

22-
.. |travis| image:: https://travis-ci.org/Chilipp/autodocsumm.svg?branch=master
23-
:alt: Travis
24-
:target: https://travis-ci.org/Chilipp/autodocsumm
22+
.. |github-action| image:: https://github.com/Chilipp/autodocsumm/workflows/Tests/badge.svg
23+
:alt: Tests
24+
:target: https://github.com/Chilipp/autodocsumm/actions?query=workflow%3A%22Tests%22
2525

26-
.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/autodocsumm/badge.svg?branch=master
27-
:alt: Coverage
28-
:target: https://coveralls.io/github/Chilipp/autodocsumm?branch=master
26+
.. |codecov| image:: https://codecov.io/gh/Chilipp/autodocsumm/branch/master/graph/badge.svg?token=I9wlZyhI4Y
27+
:alt: Codecov
28+
:target: https://codecov.io/gh/Chilipp/autodocsumm
2929

3030
.. |requires| image:: https://requires.io/github/Chilipp/autodocsumm/requirements.svg?branch=master
3131
:alt: Requirements Status

docs/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ Extending your autodoc API docs with a summary
1818
* - docs
1919
- |docs|
2020
* - tests
21-
- |travis| |requires| |coveralls|
21+
- |github-action| |requires| |codecov|
2222
* - package
2323
- |version| |supported-versions| |supported-implementations|
2424

2525
.. |docs| image:: http://readthedocs.org/projects/autodocsumm/badge/?version=latest
2626
:alt: Documentation Status
2727
:target: http://autodocsumm.readthedocs.io/en/latest/?badge=latest
2828

29-
.. |travis| image:: https://travis-ci.org/Chilipp/autodocsumm.svg?branch=master
30-
:alt: Travis
31-
:target: https://travis-ci.org/Chilipp/autodocsumm
29+
.. |github-action| image:: https://github.com/Chilipp/autodocsumm/workflows/Tests/badge.svg
30+
:alt: Tests
31+
:target: https://github.com/Chilipp/autodocsumm/actions?query=workflow%3A%22Tests%22
3232

33-
.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/autodocsumm/badge.svg?branch=master
34-
:alt: Coverage
35-
:target: https://coveralls.io/github/Chilipp/autodocsumm?branch=master
33+
.. |codecov| image:: https://codecov.io/gh/Chilipp/autodocsumm/branch/master/graph/badge.svg?token=I9wlZyhI4Y
34+
:alt: Codecov
35+
:target: https://codecov.io/gh/Chilipp/autodocsumm
3636

3737
.. |requires| image:: https://requires.io/github/Chilipp/autodocsumm/requirements.svg?branch=master
3838
:alt: Requirements Status

0 commit comments

Comments
 (0)