Replace clang-format with pre-commit (#123)

Bronek · web-flow · commit 8eb41293b7a1 · 2024-12-07T15:28:54.000Z
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,9 +15,11 @@ on:
 
 # Based on https://docs.docker.com/build/ci/github-actions/multi-platform/
 env:
-  REGISTRY_IMAGE: libfn/ci-build
+  REGISTRY_IMAGE_BUILD: libfn/ci-build
+  REGISTRY_IMAGE_PRE_COMMIT: libfn/ci-pre-commit
 
 jobs:
+
   build:
     runs-on: ubuntu-latest
     strategy:
@@ -45,8 +47,10 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}
-          tags: type=raw,value=${{ env.RELEASE }}
+          images: ${{ env.REGISTRY_IMAGE_BUILD }}-${{ env.COMPILER }}
+          tags: |
+            type=raw,value=${{ env.RELEASE }}
+            type=edge
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -68,10 +72,10 @@ jobs:
           build-args: |
             GCC_RELEASE=${{ env.RELEASE }}
             CLANG_RELEASE=${{ env.RELEASE }}
-          context: "{{defaultContext}}:ci/build"
-          file: Dockerfile.${{ env.COMPILER }}
+          context: "{{defaultContext}}:ci/build/${{ env.COMPILER }}/"
+          file: Dockerfile
           labels: ${{ steps.meta.outputs.labels }}
-          outputs: type=image,name=${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }},push-by-digest=true,name-canonical=true,push=true
+          outputs: type=image,name=${{ env.REGISTRY_IMAGE_BUILD }}-${{ env.COMPILER }},push-by-digest=true,name-canonical=true,push=true
           sbom: true
           provenance: mode=max
 
@@ -84,12 +88,12 @@ jobs:
       - name: Upload digest
         uses: actions/upload-artifact@v4
         with:
-          name: digests-${{ env.COMPILER}}-${{ env.RELEASE }}-${{ env.PLATFORM_PAIR }}
+          name: digests-build-${{ env.COMPILER}}-${{ env.RELEASE }}-${{ env.PLATFORM_PAIR }}
           path: /tmp/digests/*
           if-no-files-found: error
           retention-days: 1
 
-  merge:
+  merge-build:
     runs-on: ubuntu-latest
     needs:
       - build
@@ -112,7 +116,111 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           path: /tmp/digests
-          pattern: digests-${{ env.COMPILER}}-${{ env.RELEASE }}-*
+          pattern: digests-build-${{ env.COMPILER}}-${{ env.RELEASE }}-*
+          merge-multiple: true
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY_IMAGE_BUILD }}-${{ env.COMPILER }}
+          tags: |
+            type=raw,value=${{ env.RELEASE }}
+            type=edge
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Create manifest list and push
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.REGISTRY_IMAGE_BUILD }}-${{ env.COMPILER }}@sha256:%s ' *)
+
+      - name: Inspect image
+        run: |
+          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE_BUILD }}-${{ env.COMPILER }}:${{ steps.meta.outputs.version }}
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
+
+    steps:
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY_IMAGE_PRE_COMMIT }}
+          tags: |
+            type=schedule,pattern={{date 'YYYYMMDD'}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=edge
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          platforms: ${{ matrix.platform }}
+          context: "{{defaultContext}}:ci/pre-commit/"
+          file: Dockerfile
+          labels: ${{ steps.meta.outputs.labels }}
+          outputs: type=image,name=${{ env.REGISTRY_IMAGE_PRE_COMMIT }},push-by-digest=true,name-canonical=true,push=true
+          sbom: true
+          provenance: mode=max
+
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-pre-commit-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge-pre-commit:
+    runs-on: ubuntu-latest
+    needs:
+      - pre-commit
+
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/digests
+          pattern: digests-pre-commit-*
           merge-multiple: true
 
       - name: Set up Docker Buildx
@@ -122,8 +230,11 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}
-          tags: type=raw,value=${{ env.RELEASE }}
+          images: ${{ env.REGISTRY_IMAGE_PRE_COMMIT }}
+          tags: |
+            type=schedule,pattern={{date 'YYYYMMDD'}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=edge
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
@@ -135,8 +246,8 @@ jobs:
         working-directory: /tmp/digests
         run: |
           docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
-            $(printf '${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}@sha256:%s ' *)
+            $(printf '${{ env.REGISTRY_IMAGE_PRE_COMMIT }}@sha256:%s ' *)
 
       - name: Inspect image
         run: |
-          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}:${{ steps.meta.outputs.version }}
+          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE_PRE_COMMIT }}:${{ steps.meta.outputs.version }}
diff --git a/.github/workflows/clang-format.yml b/.github/workflows/clang-format.yml
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -0,0 +1,30 @@
+name: pre-commit
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  checks:
+    runs-on:
+      group: default
+    strategy:
+      fail-fast: false
+    container: libfn/ci-pre-commit:latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Prepare
+      run: |
+        # Required because of https://github.com/actions/checkout/issues/766
+        git config --global --add safe.directory "${GITHUB_WORKSPACE}"
+        pip freeze --local
+
+    - name: Apply pre-commit
+      run: |
+        pre-commit run --show-diff-on-failure --color=always --all-files
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 .idea/
 .idea_modules/
 .build*/
-build*/
 result
 .clangd
 .cache/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -20,10 +20,17 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v5.0.0
   hooks:
   - id: end-of-file-fixer
   - id: trailing-whitespace
+  - id: forbid-submodules
+  - id: mixed-line-ending
+  - id: check-case-conflict
+  - id: check-merge-conflict
+  - id: check-yaml
+  - id: destroyed-symlinks
+  - id: detect-private-key
 - repo: https://github.com/pre-commit/mirrors-clang-format
   rev: v18.1.8
   hooks:
diff --git a/ci/build/clang/Dockerfile b/ci/build/clang/Dockerfile
@@ -15,18 +15,14 @@ RUN set -ex ;\
       | tee /etc/apt/sources.list.d/llvm.list ;\
     apt-get update ;\
     apt-get install -t llvm-toolchain-${CODENAME}-${CLANG_RELEASE} -y --no-install-recommends \
-      clang-${CLANG_RELEASE} clang-format-${CLANG_RELEASE} \
-      libc++-${CLANG_RELEASE}-dev libc++abi-${CLANG_RELEASE}-dev ;\
+      clang++-${CLANG_RELEASE} clang-${CLANG_RELEASE} libc++-${CLANG_RELEASE}-dev libc++abi-${CLANG_RELEASE}-dev ;\
     apt-get clean
 
 RUN set -ex ;\
     update-alternatives --install \
       /usr/bin/clang clang /usr/bin/clang-${CLANG_RELEASE} 100 \
       --slave /usr/bin/clang++ clang++ /usr/bin/clang++-${CLANG_RELEASE} ;\
-    update-alternatives --install \
-      /usr/bin/clang-format clang-format /usr/bin/clang-format-${CLANG_RELEASE} 100 ;\
-    update-alternatives --auto clang ;\
-    update-alternatives --auto clang-format
+    update-alternatives --auto clang
 
 ENV CC=/usr/bin/clang
 ENV CXX=/usr/bin/clang++
diff --git a/ci/build/gcc/Dockerfile b/ci/build/gcc/Dockerfile
diff --git a/ci/pre-commit/Dockerfile b/ci/pre-commit/Dockerfile
@@ -0,0 +1,18 @@
+FROM debian:bookworm
+
+ENV DEBIAN_FRONTEND=noninteractive
+RUN set -ex ;\
+    apt-get update ;\
+    apt-get install -y --no-install-recommends \
+      python3 python3-pip python3-venv \
+      ca-certificates wget vim ;\
+    apt-get clean
+
+COPY requirements.txt /requirements.txt
+ENV VENV=/venv
+ENV PATH=${VENV}/bin:${PATH}
+RUN set -ex ;\
+    python3 -m venv ${VENV}  ;\
+    pip --no-cache-dir install -r requirements.txt
+
+WORKDIR /work
diff --git a/ci/pre-commit/requirements.txt b/ci/pre-commit/requirements.txt
@@ -0,0 +1,4 @@
+pre-commit<5
+# NOTE versions listed below must match .pre-commit-config.yaml
+clang-format==18.1.8
+pre-commit-hooks==5.0.0
diff --git a/docs/toc b/docs/toc
@@ -28,4 +28,3 @@ pack
     index
 sum
     index
-

-Original file line number
+Diff line change
@@ @@ -1,7 +1,6 @@ @@
 .idea/
 .idea_modules/
 .build*/
 -build*/
 result
 .clangd
 .cache/