[SEDONA-613] Add pre-commit hook yamllint (#1484)

https://github.com/adrienverge/yamllint https://yamllint.readthedocs.io/en/stable/ https://yamllint.readthedocs.io/en/stable/integration.html#integration-with-pre-commit https://yamllint.readthedocs.io/en/stable/rules.html Also ran `pre-commit autoupdate` to update the hooks. https://pre-commit.com/#pre-commit-autoupdate
apache · Jun 21, 2024 · 7f73a6b · 7f73a6b
1 parent 1196823
commit 7f73a6b
Show file tree

Hide file tree

Showing 13 changed files with 350 additions and 340 deletions.
diff --git a/.asf.yaml b/.asf.yaml
@@ -6,24 +6,24 @@ notifications:
     pullrequests_comment:    issues@sedona.apache.org
     jira_options: link label worklog
 github:
-  description: "A cluster computing framework for processing large-scale geospatial data"
-  homepage: https://sedona.apache.org/
-  autolink_jira:
-    - SEDONA
-  labels:
-    - geospatial
-    - cluster-computing
-    - spatial-query
-    - spatial-analysis
-    - spatial-sql
-    - scala
-    - java
-    - python
-  features:
-    # Enable wiki for documentation
-    wiki: false
-    # Enable issue management
-    issues: true
-    # Enable projects for project management boards
-    projects: false
-  ghp_branch:
+    description: "A cluster computing framework for processing large-scale geospatial data"
+    homepage: https://sedona.apache.org/
+    autolink_jira:
+        - SEDONA
+    labels:
+        - geospatial
+        - cluster-computing
+        - spatial-query
+        - spatial-analysis
+        - spatial-sql
+        - scala
+        - java
+        - python
+    features:
+        # Enable wiki for documentation
+        wiki: false
+        # Enable issue management
+        issues: true
+        # Enable projects for project management boards
+        projects: false
+    ghp_branch:
diff --git a/.github/linters/.yaml-lint.yml b/.github/linters/.yaml-lint.yml
@@ -0,0 +1,11 @@
+---
+# https://yamllint.readthedocs.io/en/stable/
+extends: default
+
+rules:
+  colons: disable
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  line-length: disable
+  truthy: false
diff --git a/.github/linters/codespell.txt b/.github/linters/codespell.txt
@@ -1,7 +1,9 @@
 actualy
 afterall
+atmost
 bu
 celle
+checkin
 eiter
 errorprone
 fpt

diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml
@@ -40,30 +40,29 @@ jobs:
     defaults:
       run:
         shell: bash
-
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: 11
-    - name: Cache Maven packages
-      uses: actions/cache@v3
-      with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
-    - name: Setup docker (missing on macOS)
-      if: runner.os == 'macos'
-      run: |
-        brew install docker
-        colima start
-        DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
-        mkdir -p $DOCKER_CONFIG/cli-plugins
-        curl -SL https://github.com/docker/buildx/releases/download/v0.14.1/buildx-v0.14.1.darwin-amd64 -o $DOCKER_CONFIG/cli-plugins/docker-buildx
-        chmod +x $DOCKER_CONFIG/cli-plugins/docker-buildx
-    - env:
-        SPARK_VERSION: ${{ matrix.spark }}
-        SEDONA_VERSION: ${{ matrix.sedona }}
-        GEOTOOLS_VERSION: ${{ matrix.geotools }}
-      run: ./docker/sedona-spark-jupyterlab/build.sh ${SPARK_VERSION} ${SEDONA_VERSION} local ${GEOTOOLS_VERSION}
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 11
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Setup docker (missing on macOS)
+        if: runner.os == 'macos'
+        run: |
+          brew install docker
+          colima start
+          DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
+          mkdir -p $DOCKER_CONFIG/cli-plugins
+          curl -SL https://github.com/docker/buildx/releases/download/v0.14.1/buildx-v0.14.1.darwin-amd64 -o $DOCKER_CONFIG/cli-plugins/docker-buildx
+          chmod +x $DOCKER_CONFIG/cli-plugins/docker-buildx
+      - env:
+          SPARK_VERSION: ${{ matrix.spark }}
+          SEDONA_VERSION: ${{ matrix.sedona }}
+          GEOTOOLS_VERSION: ${{ matrix.geotools }}
+        run: ./docker/sedona-spark-jupyterlab/build.sh ${SPARK_VERSION} ${SEDONA_VERSION} local ${GEOTOOLS_VERSION}
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -15,62 +15,62 @@ jobs:
   build:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Set up Java
-      uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: '8'
-    - name: Compile JavaDoc
-      run: mvn -q clean install -DskipTests && mkdir -p docs/api/javadoc/spark && cp -r spark/common/target/apidocs/* docs/api/javadoc/spark/
-    - name: Compile ScalaDoc
-      run: mvn scala:doc && mkdir -p docs/api/scaladoc/spark && cp -r spark/common/target/site/scaladocs/* docs/api/scaladoc/spark
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3.x
-    - run: pip install mkdocs-jupyter
-    - run: pip install mkdocs-material
-    - run: pip install mkdocs-macros-plugin
-    - run: pip install mkdocs-git-revision-date-localized-plugin
-    - run: pip install mike
-    - run: sudo apt update
-    - uses: r-lib/actions/setup-r@v2
-      with:
-        r-version: release
-        use-public-rspm: true
-    - name: Query R dependencies
-      uses: r-lib/actions/setup-r-dependencies@v2
-      with:
-        cache: true
-        extra-packages: |
-          any::pkgdown
-        working-directory : './R'
-    - run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE, override = list(destination = "../docs/api/rdocs"))'
-    - run: git config --global user.name = "GitHub Action"
-    - run: git config --global user.email = "test@abc.com"
-    - run: mkdocs build
-    - run: git fetch origin website --depth=1
-    - name: Deploy the doc to the website branch
-      if: ${{ github.event_name != 'pull_request' && github.repository == 'apache/sedona' }}
-      run: mike deploy latest-snapshot -b website -p
-    - run: mkdir staging
-    - run: cp -r site/* staging/
-    - uses: actions/upload-artifact@v3
-      with:
-        name: generated-docs
-        path: staging
-    - name: Cache Python packages
-      uses: actions/cache@v3
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-    - name: Cache Maven packages
-      uses: actions/cache@v3
-      with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: '8'
+      - name: Compile JavaDoc
+        run: mvn -q clean install -DskipTests && mkdir -p docs/api/javadoc/spark && cp -r spark/common/target/apidocs/* docs/api/javadoc/spark/
+      - name: Compile ScalaDoc
+        run: mvn scala:doc && mkdir -p docs/api/scaladoc/spark && cp -r spark/common/target/site/scaladocs/* docs/api/scaladoc/spark
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-jupyter
+      - run: pip install mkdocs-material
+      - run: pip install mkdocs-macros-plugin
+      - run: pip install mkdocs-git-revision-date-localized-plugin
+      - run: pip install mike
+      - run: sudo apt update
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: release
+          use-public-rspm: true
+      - name: Query R dependencies
+        uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          cache: true
+          extra-packages: |
+            any::pkgdown
+          working-directory : './R'
+      - run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE, override = list(destination = "../docs/api/rdocs"))'
+      - run: git config --global user.name = "GitHub Action"
+      - run: git config --global user.email = "test@abc.com"
+      - run: mkdocs build
+      - run: git fetch origin website --depth=1
+      - name: Deploy the doc to the website branch
+        if: ${{ github.event_name != 'pull_request' && github.repository == 'apache/sedona' }}
+        run: mike deploy latest-snapshot -b website -p
+      - run: mkdir staging
+      - run: cp -r site/* staging/
+      - uses: actions/upload-artifact@v3
+        with:
+          name: generated-docs
+          path: staging
+      - name: Cache Python packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
diff --git a/.github/workflows/example.yml b/.github/workflows/example.yml
@@ -18,7 +18,6 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
@@ -33,37 +32,36 @@ jobs:
           - spark: 3.3.4
             spark-compat: '3.0'
             sedona: 1.5.1
-
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: '8'
-    - run: sudo apt-get remove scala-library scala
-    - run: sudo wget www.scala-lang.org/files/archive/scala-2.12.11.deb
-    - run: sudo dpkg -i scala-2.12.11.deb
-    - run: scala -version
-    - run: echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | sudo tee -a /etc/apt/sources.list.d/sbt.list
-    - run: sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823
-    - run: sudo apt-get update
-    - run: sudo apt-get install sbt
-    - name: Cache SBT
-      uses: actions/cache@v3
-      with:
-        path: |
-          ~/.ivy2/cache
-          ~/.sbt
-        key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
-    - name: Cache Maven packages
-      uses: actions/cache@v3
-      with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
-    - env:
-        SPARK_VERSION: ${{ matrix.spark }}
-        SPARK_COMPAT_VERSION: ${{ matrix.spark-compat }}
-        SEDONA_VERSION: ${{ matrix.sedona }}
-      run: (cd examples/spark-sql;mvn clean install -Dspark.version=${SPARK_VERSION} -Dspark.compat.version=${SPARK_COMPAT_VERSION} -Dsedona.version=${SEDONA_VERSION};java -jar target/sedona-spark-example-1.6.0.jar)
-    - run: (cd examples/flink-sql;mvn clean install;java -jar target/sedona-flink-example-1.6.0.jar)
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: '8'
+      - run: sudo apt-get remove scala-library scala
+      - run: sudo wget www.scala-lang.org/files/archive/scala-2.12.11.deb
+      - run: sudo dpkg -i scala-2.12.11.deb
+      - run: scala -version
+      - run: echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | sudo tee -a /etc/apt/sources.list.d/sbt.list
+      - run: sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823
+      - run: sudo apt-get update
+      - run: sudo apt-get install sbt
+      - name: Cache SBT
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.ivy2/cache
+            ~/.sbt
+          key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - env:
+          SPARK_VERSION: ${{ matrix.spark }}
+          SPARK_COMPAT_VERSION: ${{ matrix.spark-compat }}
+          SEDONA_VERSION: ${{ matrix.sedona }}
+        run: (cd examples/spark-sql;mvn clean install -Dspark.version=${SPARK_VERSION} -Dspark.compat.version=${SPARK_COMPAT_VERSION} -Dsedona.version=${SEDONA_VERSION};java -jar target/sedona-spark-example-1.6.0.jar)
+      - run: (cd examples/flink-sql;mvn clean install;java -jar target/sedona-flink-example-1.6.0.jar)