Skip to content

Commit 8c3de13

Browse files
JustBeYouamotl
authored andcommitted
Documentation: add info about CI pipeline steps to developing guide
1 parent ddfc7a3 commit 8c3de13

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,8 @@ jobs:
4646
python -m pip install --upgrade pip
4747
python -m pip install ".[test,devel]"
4848
49-
- name: Test
50-
run: |
51-
isort --check --diff crate/ tests/ setup.py
52-
flake8 crate/crash
53-
coverage run -m unittest -v
49+
- name: Lint & test
50+
run: ./devtools/ci.sh
5451

5552
pypi:
5653
name: Build & publish package to pypi

DEVELOP.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,25 @@ Afterwards you can launch crash::
1818

1919
crash
2020

21+
Continuous Integration
22+
======================
23+
24+
You can run all CI steps using::
25+
26+
./devtools/ci.sh
27+
28+
Individual steps are described below.
29+
30+
Linting
31+
-------
32+
33+
You can check if your code is compliant to the project's standard using::
34+
35+
isort --check --diff crate/ tests/ setup.py
36+
flake8 crate/crash
2137

2238
Running Tests
23-
=============
39+
-------------
2440

2541
The tests are run using the `unittest`_ module::
2642

@@ -42,7 +58,6 @@ To run against a single interpreter, you can also do::
4258

4359
tox -e py33
4460

45-
4661
Standalone Executable
4762
=====================
4863

devtools/ci.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/sh
2+
3+
set -e -x
4+
5+
isort --check --diff crate/ tests/ setup.py
6+
flake8 crate/crash
7+
coverage run -m unittest -v

0 commit comments

Comments
 (0)