Merge pull request #3066 from arnav13081994/update_cicd

tests/test_cookiecutter_generation.py

@@ -234,7 +234,7 @@ def test_gitlab_invokes_flake8_and_pytest(
         ("y", "docker-compose -f local.yml exec -T django pytest"),
     ],
 )
-def test_github_invokes_flake8_and_pytest(
+def test_github_invokes_linter_and_pytest(
     cookies, context, use_docker, expected_test_script
 ):
     context.update({"ci_tool": "Github", "use_docker": use_docker})
@@ -248,11 +248,11 @@ def test_github_invokes_flake8_and_pytest(
     with open(f"{result.project}/.github/workflows/ci.yml", "r") as github_yml:
         try:
             github_config = yaml.safe_load(github_yml)
-            flake8_present = False
-            for action_step in github_config["jobs"]["flake8"]["steps"]:
-                if action_step.get("run") == "flake8":
-                    flake8_present = True
-            assert flake8_present
+            linter_present = False
+            for action_step in github_config["jobs"]["linter"]["steps"]:
+                if action_step.get("uses", "NA").startswith("pre-commit"):
+                    linter_present = True
+            assert linter_present
 
             expected_test_script_present = False
             for action_step in github_config["jobs"]["pytest"]["steps"]:

{{cookiecutter.project_slug}}/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ on:
 
 
 jobs:
-  flake8:
+  linter:
     runs-on: ubuntu-latest
     steps:
 
@@ -28,13 +28,11 @@ jobs:
         with:
           python-version: 3.8
 
-      - name: Install flake8
-        run: |
-          python -m pip install --upgrade pip
-          pip install flake8
-
-      - name: Lint with flake8
-        run: flake8
+      # 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/action@v2.0.0
 
 # With no caching at all the entire ci process takes 4m 30s to complete!
   pytest: