Skip to content

Commit

Permalink
Documentation: add info about CI pipeline steps to developing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
JustBeYou authored and amotl committed Jun 18, 2023
1 parent ddfc7a3 commit 8c3de13
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 7 deletions.
7 changes: 2 additions & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,8 @@ jobs:
python -m pip install --upgrade pip
python -m pip install ".[test,devel]"
- name: Test
run: |
isort --check --diff crate/ tests/ setup.py
flake8 crate/crash
coverage run -m unittest -v
- name: Lint & test
run: ./devtools/ci.sh

pypi:
name: Build & publish package to pypi
Expand Down
19 changes: 17 additions & 2 deletions DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,25 @@ Afterwards you can launch crash::

crash

Continuous Integration
======================

You can run all CI steps using::

./devtools/ci.sh

Individual steps are described below.

Linting
-------

You can check if your code is compliant to the project's standard using::

isort --check --diff crate/ tests/ setup.py
flake8 crate/crash

Running Tests
=============
-------------

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

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

tox -e py33


Standalone Executable
=====================

Expand Down
7 changes: 7 additions & 0 deletions devtools/ci.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh

set -e -x

isort --check --diff crate/ tests/ setup.py
flake8 crate/crash
coverage run -m unittest -v

0 comments on commit 8c3de13

Please sign in to comment.