Skip to content

Commit f41dc26

Browse files
committed
Build documentation using GitHub Actions
- complete replaced Travis.CI
1 parent d15447f commit f41dc26

File tree

5 files changed

+72
-83
lines changed

5 files changed

+72
-83
lines changed

.github/workflows/builddocs.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: DocBuild
2+
3+
on:
4+
push:
5+
branches: master
6+
7+
defaults:
8+
run:
9+
shell: bash
10+
11+
jobs:
12+
build_docs:
13+
runs-on: ${{ matrix.os }}
14+
strategy:
15+
matrix:
16+
os: [ubuntu-latest]
17+
python-version: [3.8]
18+
steps:
19+
- name: Checkout master
20+
uses: actions/checkout@v2
21+
with:
22+
path: main
23+
- name: Check for documentation changes
24+
run: |
25+
cd main
26+
echo "LAST_COMMIT=$(echo `git log -1 --pretty=%B`)" >> $GITHUB_ENV
27+
echo "LAST_DOC_COMMIT=$(echo `git log -1 --pretty=%B docs`)" >> $GITHUB_ENV
28+
if [ "$LAST_COMMIT" != "$LAST_DOC_COMMIT" ]; then
29+
echo "No changes in documentation, skipping"
30+
exit 0
31+
fi
32+
- name: Install needed packages
33+
run: |
34+
pip3 install wheel
35+
pip3 install pytest
36+
sudo apt-get install python3-sphinx
37+
cd main/docs
38+
make html
39+
- name: Checkout gh-pages
40+
uses: actions/checkout@v2
41+
with:
42+
ref: gh-pages
43+
path: doc
44+
- name: Copy and commit changes
45+
run: |
46+
cp -r main/docs/build/html/* doc/dev
47+
cd doc
48+
git config user.name "Travis CI"
49+
git config user.email "[email protected]"
50+
git commit -a -m "$LAST_COMMIT"
51+
git push

.github/workflows/pythontests.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ jobs:
2929
with:
3030
path: ${{ steps.pip-cache.outputs.dir }}
3131
key: py${{ matrix.python-version }}-${{ matrix.os }}-pip
32-
3332
- name: Install linter
3433
run: python -m pip install flake8
3534
- name: Check syntax and style
@@ -76,5 +75,3 @@ jobs:
7675
env:
7776
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7877
run: coveralls
79-
80-

.travis.yml

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

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,38 @@
1-
pytest-order [![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://badge.fury.io/py/pytest-order) [![Build Status](https://travis-ci.org/mrbean-bremen/pytest-order.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-order) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://img.shields.io/pypi/pyversions/pytest-order.svg)
2-
============
1+
_pytest-order_ - a pytest plugin to order test execution
2+
========================================================
3+
4+
[![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://badge.fury.io/py/pytest-order) [![Build Status](https://travis-ci.org/mrbean-bremen/pytest-order.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-order) [![Coverage Status](https://img.shields.io/coveralls/github/mrbean-bremen/pytest-order)](https://coveralls.io/github/badges/shields?branch=master) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://img.shields.io/pypi/pyversions/pytest-order.svg)
5+
36
`pytest-order` is a pytest plugin that allows you to customize the order in which
47
your tests are run. It uses the marker `order` that defines when a specific
58
test shall be run relative to the other tests.
69

10+
Documentation
11+
-------------
12+
Apart from this overview, the following information is available:
13+
- usage documentation for the [latest release](https://mrbean-bremen.github.io/pytest-order/stable/)
14+
- usage documentation for the [current master](https://mrbean-bremen.github.io/pytest-order/dev/)
15+
- the [Release Notes](https://github.com/mrbean-bremen/pytest-order/blob/master/CHANGELOG.md)
16+
with a list of changes in the latest versions
17+
18+
History
19+
-------
720
This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
821
That project is not maintained anymore, and there are several helpful PRs
922
that are now integrated into `pytest-order`. The idea and most of the code
1023
has been created by Frank Tobia, the author of that plugin. In case
1124
`pytest-ordering` is revived, this project will be obsolete.
1225

13-
_Note:_ `pytest-order` is not compatible with `pytest-ordering` due to the
26+
Compatibility to `pytest_ordering`
27+
---------------------------------
28+
`pytest-order` is **not** compatible with `pytest-ordering` due to the
1429
changed marker name (`order` instead of `run`). Only the `order`
1530
marker is supported, support for all additional markers has been removed for
1631
consistence (see [this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
1732

18-
More information can be found in the documentation:
19-
- for the [latest release](https://mrbean-bremen.github.io/pytest-order/stable/)
20-
- for the [current master](https://mrbean-bremen.github.io/pytest-order/dev/)
21-
22-
_From the original project:_
33+
Overview
34+
--------
35+
_(from the original project)_
2336

2437
Have you ever wanted to easily run one of your tests before any others run?
2538
Or run some tests last? Or run this one test before that other test? Or

build-docs.sh

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

0 commit comments

Comments
 (0)