Skip to content

Commit

Permalink
Merge pull request #122 from manics/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
consideRatio authored Apr 5, 2021
2 parents 50a5180 + f5c39d9 commit e52a7f1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,6 @@ charts:
## Caveats
### TravisCI mirror image registry
If you run chartpress on TravisCI, its logic can be fooled by a mirror image
registry to rebuild something that didn't need rebuilding. A workaround for this
can be found in this repo's [.travis.yml](.travis.yml).
### Shallow clones
Chartpress detects the latest commit which changed a directory or file when
Expand All @@ -225,6 +219,11 @@ git:
depth: false
```

### Command caching

Chartpress caches the results of some commands to improve performance.
This means chartpress should not be used as an importable library.

## Development

Testing of this python package can be done using
Expand All @@ -238,6 +237,9 @@ pip install -e .
# install dev dependencies
pip install -r dev-requirements.txt
# format and lint code
pre-commit run -a
# run tests
pytest --verbose --flake8 --exitfirst
pytest --verbose --exitfirst
```
1 change: 1 addition & 0 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
bump2version
gitpython
pre-commit
pytest
pytest-flake8

0 comments on commit e52a7f1

Please sign in to comment.