Skip to content
This repository has been archived by the owner on Jun 9, 2019. It is now read-only.

Add testing/build steps to the README #9

Open
abatilo opened this issue Sep 14, 2018 · 0 comments
Open

Add testing/build steps to the README #9

abatilo opened this issue Sep 14, 2018 · 0 comments

Comments

@abatilo
Copy link
Owner

abatilo commented Sep 14, 2018

Every time we receive a PR, we run the following steps:

lint_git_commits:
docker:
- image: python:3.6
working_directory: ~/sanic-swagger
steps:
- checkout
- run: pip install gitlint
- run: gitlint --commits fbb925a...HEAD
lint:
docker:
- image: python:3.6
working_directory: ~/sanic-swagger
steps:
- checkout
- run: pip install pipenv
- run: pipenv install --dev
- run: pipenv run flake8 --show-source --import-order-style pep8
test:
docker:
- image: python:3.6
working_directory: ~/sanic-swagger
steps:
- checkout
- run: pip install pipenv
- run: pipenv install --dev
- run: pipenv run pytest --cov-report html --cov-report xml:codecov.xml --junit-xml=coverage.xml --cov-branch --cov-fail-under=90 -v --cov=sanic_swagger tests/
- run: mkdir -p test-results/pytest && cp coverage.xml test-results/pytest/results.xml

It would be extremely useful to have sections in the README for how to run these locally, so that people who want to contribute, can make sure that all of these steps will pass locally, before pushing the PR.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant