Merge pull request #4 from alexdewar/precommit_ci

Precommit CI

.github/workflows/check-links.yml

@@ -2,6 +2,10 @@ name: Check links in Markdown files
 on:
   schedule:
     - cron: "0 0 * * 1" # midnight every Monday
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   check-links:

.github/workflows/ci.yml

@@ -7,16 +7,6 @@ on:
   workflow_dispatch:
 
 jobs:
-  check-links:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
-        name: Check links in markdown files
-        with:
-          use-quiet-mode: "yes"
-          use-verbose-mode: "yes"
-
   test:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -51,3 +41,10 @@ jobs:
       - name: Run tests
         working-directory: my_project
         run: poetry run pytest
+
+      - name: Run pre-commit hooks for project
+        working-directory: my_project
+        run: |
+          git init
+          git add .
+          poetry run pre-commit run -a

cookiecutter.json

@@ -1,17 +1,19 @@
 {
     "project_name": "My Project",
     "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
-    "project_description": "",
+    "project_description": "[Description for project.]",
     "author": "Jane Doe",
     "author_email": "[email protected]",
     "use_bsd3_licence": false,
+    "add_precommit_workflows": true,
     "_copy_without_render": [".github"],
     "__prompts__": {
         "project_name": "Enter a human-readable name for the project",
         "project_slug": "Enter a name for the Python package",
         "project_description": "Enter a brief description of the project",
         "author": "Enter your full name",
         "author_email": "Enter your email address",
-        "use_bsd3_licence": "Whether to use Imperial's default open-source licence (BSD 3-clause)"
+        "use_bsd3_licence": "Whether to use Imperial's default open-source licence (BSD 3-clause)",
+        "add_precommit_workflows": "Add Github Actions to run pre-commit hooks (only needed for private repositories)"
     }
 }

hooks/post_gen_project.py

@@ -1,7 +1,9 @@
 import os
 
 REMOVE_PATHS = [
-    "{% if not cookiecutter.use_bsd3_licence %}LICENSE{% endif %}"
+    "{% if not cookiecutter.use_bsd3_licence %}LICENSE{% endif %}",
+    "{% if not cookiecutter.add_precommit_workflows %}.github/workflows/pre-commit.yml{% endif %}",
+    "{% if not cookiecutter.add_precommit_workflows %}.github/workflows/pre-commit_autoupdate.yml{% endif %}"
 ]
 
 for path in REMOVE_PATHS:

{{ cookiecutter.project_slug }}/.github/workflows/check-links.yml

@@ -2,6 +2,10 @@ name: Check links in Markdown files
 on:
   schedule:
     - cron: "0 0 * * 1" # midnight every Monday
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   check-links:

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

@@ -1,26 +1,13 @@
 name: Test and build
 
-on: [push, pull_request, workflow_call]
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
 
 jobs:
-  qa:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pre-commit/[email protected]
-
-  check-links:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
-        name: Check links in markdown files
-        with:
-          use-quiet-mode: "yes"
-          use-verbose-mode: "yes"
-
   test:
-    needs: qa
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

{{ cookiecutter.project_slug }}/.github/workflows/pre-commit.yml

@@ -0,0 +1,15 @@
+name: Run pre-commit hooks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pre-commit/[email protected]
+      - uses: pre-commit-ci/[email protected]
+        if: always()