Update readme and commands #61
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| # Enable Buildkit and let compose use it to speed up image building | |
| env: | |
| DOCKER_BUILDKIT: 1 | |
| COMPOSE_DOCKER_CLI_BUILD: 1 | |
| on: | |
| pull_request: | |
| branches: ["master", "main", "develop"] | |
| paths-ignore: ["docs/**"] | |
| push: | |
| branches: ["master", "main", "develop"] | |
| paths-ignore: ["docs/**"] | |
| jobs: | |
| linter: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code Repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.9 | |
| uses: actions/[email protected] | |
| with: | |
| python-version: 3.9 | |
| # Run all pre-commit hooks on all the files. | |
| # Getting only staged files can be tricky in case a new PR is opened | |
| # since the action is run on a branch in detached head state | |
| - name: Install and Run Pre-commit | |
| uses: pre-commit/[email protected] | |
| mypy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code Repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.9 | |
| uses: actions/[email protected] | |
| with: | |
| python-version: 3.9 | |
| - name: Get pip cache dir | |
| id: pip-cache-location | |
| run: | | |
| echo "::set-output name=dir::$(pip cache dir)" | |
| - name: Cache pip Project Dependencies | |
| uses: actions/[email protected] | |
| with: | |
| # Get the location of pip cache dir | |
| path: ${{ steps.pip-cache-location.outputs.dir }} | |
| # Look to see if there is a cache hit for the corresponding requirements file | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/local.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Check types | |
| run: mypy . | |
| tests: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code Repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.9 | |
| uses: actions/[email protected] | |
| with: | |
| python-version: 3.9 | |
| - name: Get pip cache dir | |
| id: pip-cache-location | |
| run: | | |
| echo "::set-output name=dir::$(pip cache dir)" | |
| - name: Cache pip Project Dependencies | |
| uses: actions/[email protected] | |
| with: | |
| # Get the location of pip cache dir | |
| path: ${{ steps.pip-cache-location.outputs.dir }} | |
| # Look to see if there is a cache hit for the corresponding requirements file | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/local.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Django Tests | |
| run: python manage.py test |