ci: add pre-commit and overhaul the ci

.github/workflows/buildtest.yaml → .github/workflows/build-and-test.yml

@@ -1,4 +1,4 @@
-name: buildtest
+name: build-and-test
 on:
   pull_request_target:
     types: [ assigned, opened, synchronize, reopened ]
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  build_test:
+  build-and-test:
     runs-on: ubuntu-22.04
     strategy:
       fail-fast: false

.github/workflows/documentation_generation.yml

@@ -2,15 +2,12 @@ name: documentation_generation
 on:
   push:
     branches:
-      - master 
       - main
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.x
-      - run: pip install mkdocs-material 
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v3
+      - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --force

.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - uses: pre-commit/[email protected]
+      - uses: pre-commit-ci/[email protected]
+        if: always()

.gitignore

@@ -71,4 +71,3 @@ crashlytics-build.properties
 
 # JetBrains
 .idea/
-

.pre-commit-config-local.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: dotnet-format
+        name: dotnet-format
+        language: system
+        entry: dotnet format AWSIM.sln --include
+        types_or: [ "c#", "vb" ]
+
+# https://github.com/Unity-Technologies/Unity-Robotics-Hub/blob/main/.pre-commit-config.yaml
+exclude: >
+  (?x)^(
+      .*.css|
+      .*.meta|
+      .*.mat|
+      .*.preset|
+      .*.lighting|
+      .*.dae
+      .*.unity
+      .*.asset
+      .*.prefab
+      .*.controller
+  )$

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+ci:
+  autofix_commit_msg: "style(pre-commit): autofix"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ --fix=lf ]
+      - id: trailing-whitespace
+        args: [ --markdown-linebreak-ext=md ]
+      - id: check-yaml
+        args: [--unsafe]
+
+  - repo: local
+    hooks:
+      - id: dotnet-format
+        name: dotnet-format
+        language: system
+        entry: dotnet format whitespace
+        args:
+          - --folder
+          - --include
+        types_or: [ "c#", "vb" ]
+
+# https://github.com/Unity-Technologies/Unity-Robotics-Hub/blob/main/.pre-commit-config.yaml
+exclude: >
+  (?x)^(
+      .*.css|
+      .*.meta|
+      .*.mat|
+      .*.preset|
+      .*.lighting|
+      .*.dae|
+      .*.unity|
+      .*.asset|
+      .*.prefab|
+      .*.controller
+  )$

.vsconfig

@@ -1,6 +1,6 @@
 {
   "version": "1.0",
-  "components": [ 
+  "components": [
     "Microsoft.VisualStudio.Workload.ManagedGame"
   ]
-} 
+}

Assets/AWSIM/Models/Vehicles/Lexus RX450h 2015/Car Shader Graph.shadergraph

@@ -7162,4 +7162,3 @@
         "w": 0.0
     }
 }
-

Assets/AWSIM/Scenes/Main/AutowareSimulation/AutowareSimulation.cs

@@ -47,7 +47,7 @@ public class Configuration
         void Awake()
         {
             // check if time source selector is present
-            if(timeSourceSelector == null)
+            if (timeSourceSelector == null)
             {
                 Debug.LogWarning("TimeSource: There is no TimeSourceSelector object assigned in the inspector. The default time source will be used.");
             }
@@ -103,4 +103,4 @@ void Awake()
             }
         }
     }
-}
+}

Assets/AWSIM/Scenes/Main/PointCloudMapping/Scripts/Geometry/Paths/Path.cs

@@ -1,11 +1,13 @@
 using UnityEngine;
 
-namespace AWSIM.PointCloudMapping.Geometry {
+namespace AWSIM.PointCloudMapping.Geometry
+{
     /// <summary>
     /// Base class for paths for interpolated iterations along an array of point.
     /// </summary>
     /// <typeparam name="TPoint"></typeparam>
-    public abstract class Path<TPoint> {
+    public abstract class Path<TPoint>
+    {
         /// <summary>
         /// Get the length of the path.
         /// </summary>
@@ -16,7 +18,8 @@ public abstract class Path<TPoint> {
         /// </summary>
         /// <param name="distance"></param>
         /// <returns>Position of the point</returns>
-        public Vector3 this[float distance] {
+        public Vector3 this[float distance]
+        {
             get => Point(distance);
         }
 

Assets/AWSIM/Scenes/Main/PointCloudMapping/Scripts/Mapper/LaneletVisualizer.cs

@@ -13,7 +13,7 @@ public class LaneletVisualizer
     {
         [SerializeField]
         private Material material;
-        
+
         [SerializeField]
         private float width;
 

Assets/AWSIM/Scenes/Main/PointCloudMapping/Scripts/Mapper/PointCloudMapper.cs

@@ -60,7 +60,7 @@ private void Start()
 
             var start = Time.realtimeSinceStartup;
             capturePoseQueue = new Queue<Pose>(LaneletMapToPoses(laneletMap, captureLocationInterval));
-            var computeTimeMs = (Time.realtimeSinceStartup - start) * 1000f; 
+            var computeTimeMs = (Time.realtimeSinceStartup - start) * 1000f;
             Debug.Log($"Will visit {capturePoseQueue.Count} points; computed in {computeTimeMs} ms");
 
             laneletVisualizer.Initialize(laneletMap);

Assets/AWSIM/Scenes/Main/PointCloudMapping/Scripts/Mapper/RGLMappingAdapter.cs

@@ -54,7 +54,7 @@ public void Awake()
         }
 
         // Empty function to make enable checkbox appear in the Inspector
-        public void Start() {}
+        public void Start() { }
 
         public void Initialize(Vector3 worldOriginROS, string outputPcdFilePath)
         {
@@ -67,11 +67,11 @@ public void Initialize(Vector3 worldOriginROS, string outputPcdFilePath)
 
             // Create and connect subgraph
             Matrix4x4 worldTransform = ROS2.Transformations.Unity2RosMatrix4x4();
-            worldTransform.SetColumn(3, worldTransform.GetColumn(3) + (Vector4) worldOriginROS);
+            worldTransform.SetColumn(3, worldTransform.GetColumn(3) + (Vector4)worldOriginROS);
             rglSubgraphMapping = new RGLNodeSequence()
                 .AddNodePointsTransform(rosWorldTransformNodeId, worldTransform)
                 .AddNodePointsDownsample(downsampleNodeId, new Vector3(leafSize, leafSize, leafSize))
-                .AddNodePointsTemporalMerge(temporalMergeNodeId, new RGLField[1] {RGLField.XYZ_VEC3_F32});
+                .AddNodePointsTemporalMerge(temporalMergeNodeId, new RGLField[1] { RGLField.XYZ_VEC3_F32 });
 
             rglSubgraphMapping.SetActive(downsampleNodeId, enableDownsampling);