From c44e567ad9f39057b6e630ffd11665a214cd2799 Mon Sep 17 00:00:00 2001
From: Abel Soares Siqueira <abel.siqueira@esciencecenter.nl>
Date: Mon, 12 Aug 2024 10:59:16 +0200
Subject: [PATCH] Test pre-commit in the generated package

Run pre-commit run -a twice in the generated package.
The first run should fix all issues.
The second run should pass because all issues were fixed.
This ensures that the promoted experience in package generation
is correct.

Closes #390
---
 .github/workflows/TestGeneratedPkg.yml | 39 ++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/TestGeneratedPkg.yml b/.github/workflows/TestGeneratedPkg.yml
index 7650e5be..2555b43a 100644
--- a/.github/workflows/TestGeneratedPkg.yml
+++ b/.github/workflows/TestGeneratedPkg.yml
@@ -48,27 +48,54 @@ jobs:
           arch: ${{ matrix.arch }}
       - name: Use Julia cache
         uses: julia-actions/cache@v2
-      - uses: julia-actions/julia-buildpkg@v1
+      - name: Build the package
+        uses: julia-actions/julia-buildpkg@v1
+      - name: Install JuliaFormatter.jl
+        run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          cache: "pip"
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('**/.pre-commit-config.yaml') }}
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      # Actual tests
       - name: Create a package using the template
         run: |
           julia --project=. --eval '
             using BestieTemplate, UUIDs;
-            t = Dict(
+            data = Dict(
               "PackageName" => "Guldasta",
               "PackageUUID" => string(UUIDs.uuid4()),
               "PackageOwner" => "Bagicha",
               "AuthorName" => "Mali",
               "AuthorEmail" => "mali@bagicha.site"
             );
-            BestieTemplate.generate("tmp/Guldasta.jl", t; defaults = true, quiet = true);
+            BestieTemplate.generate("tmp/Guldasta.jl", data; defaults = true, quiet = true);
           '
-      - name: Test generated package
+      - name: Run the tests in the generated package
         run: |
           julia --project=tmp/Guldasta.jl --eval 'using Pkg; Pkg.test()'
-      - name: Generate docs
+      - name: Build the docs of the generated package
         run: |
           julia --project=tmp/Guldasta.jl/docs --eval 'using Pkg; pkg"dev tmp/Guldasta.jl"' \
             -L tmp/Guldasta.jl/docs/make.jl
-      - name: Check docs generation
+      - name: Check that the docs wre properly generated
         run: |
           ./.github/scripts/check-docs.bash tmp/Guldasta.jl
+      - name: Check that running pre-commit will fix its own issues
+        shell: bash {0} # The default shell uses -e which checks intermediary failures
+        run: |
+          cd tmp/Guldasta.jl
+          git config --global user.email "action@github.com"
+          git config --global user.name "GitHub action"
+          git init
+          git add .
+          git commit -m "First commit"
+          SKIP=no-commit-to-branch pre-commit run -a # Should fail
+          SKIP=no-commit-to-branch pre-commit run -a # Should not