chore: Spotless가 YAML 파일을 체크하도록 설정 추가 (#252)

* chore: YAML 포맷팅 설정 추가 * chore: spotless yaml 적용
GDSC-Hongik · Mar 4, 2024 · e462a38 · e462a38
1 parent 1ef7d5a
commit e462a38
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 26 deletions.
diff --git a/.github/workflows/develop_build_deploy.yml b/.github/workflows/develop_build_deploy.yml
@@ -2,7 +2,7 @@ name: Build and Deploy to Develop
 
 on:
   push:
-    branches: [ "develop" ]
+    branches: ["develop"]
 
 permissions:
   id-token: write
@@ -17,8 +17,8 @@ jobs:
     environment: develop
     strategy:
       matrix:
-        java-version: [ 17 ]
-        distribution: [ 'temurin' ]
+        java-version: [17]
+        distribution: ["temurin"]
     steps:
       # 체크아웃
       - name: Checkout
@@ -103,12 +103,13 @@ jobs:
         uses: Ilshidur/action-discord@master
         env:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-          DISCORD_EMBEDS: '[
-            {
-              "title": "푸드덕푸드덕푸드덕",
-              "description": "구구구구국 구구...: ${{ steps.gradle.outputs.build-scan-url }}"
-            }
-          ]'
+          DISCORD_EMBEDS: |
+            [
+              {
+                "title": "푸드덕푸드덕푸드덕",
+                "description": "구구구구국 구구...: ${{ steps.gradle.outputs.build-scan-url }}"
+              }
+            ]
 
       # EC2로 배포
       - name: Deploy to EC2 Server
@@ -120,7 +121,7 @@ jobs:
           host: ${{ secrets.EC2_HOST }}
           username: ${{ secrets.EC2_USERNAME }}
           key: ${{ secrets.EC2_PRIVATE_KEY }}
-          envs: IMAGE_FULL_URL  # docker-compose.yml 에서 사용할 환경 변수
+          envs: IMAGE_FULL_URL # docker-compose.yml 에서 사용할 환경 변수
           script: |
             aws s3 cp ${{ env.S3_COPY_PATH }} docker-compose.yml
             echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin

diff --git a/.github/workflows/develop_deploy.yml b/.github/workflows/develop_deploy.yml
@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       commit_hash:
-        description: 'commit_hash'
+        description: "commit_hash"
         required: true
 
 jobs:
@@ -21,7 +21,7 @@ jobs:
           host: ${{ secrets.EC2_HOST }}
           username: ${{ secrets.EC2_USERNAME }}
           key: ${{ secrets.EC2_PRIVATE_KEY }}
-          envs: IMAGE_FULL_URL  # docker-compose.yml 에서 사용할 환경 변수
+          envs: IMAGE_FULL_URL # docker-compose.yml 에서 사용할 환경 변수
           script: |
             echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin
             docker pull ${{ env.IMAGE_FULL_URL }}

diff --git a/.github/workflows/production_build_deploy.yml b/.github/workflows/production_build_deploy.yml
@@ -17,8 +17,8 @@ jobs:
     environment: production
     strategy:
       matrix:
-        java-version: [ 17 ]
-        distribution: [ 'temurin' ]
+        java-version: [17]
+        distribution: ["temurin"]
     steps:
       # 체크아웃
       - name: Checkout
@@ -119,12 +119,13 @@ jobs:
         uses: Ilshidur/action-discord@master
         env:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-          DISCORD_EMBEDS: '[
-            {
-              "title": "푸드덕푸드덕푸드덕",
-              "description": "구구구구국 구구...: ${{ steps.gradle.outputs.build-scan-url }}"
-            }
-          ]'
+          DISCORD_EMBEDS: |
+            [
+              {
+                "title": "푸드덕푸드덕푸드덕",
+                "description": "구구구구국 구구...: ${{ steps.gradle.outputs.build-scan-url }}"
+              }
+            ]
 
       - name: Deploy to EC2 Server
         uses: appleboy/ssh-action@master
@@ -135,7 +136,7 @@ jobs:
           host: ${{ secrets.EC2_HOST }}
           username: ${{ secrets.EC2_USERNAME }}
           key: ${{ secrets.EC2_PRIVATE_KEY }}
-          envs: IMAGE_FULL_URL  # docker-compose.yml 에서 사용할 환경 변수
+          envs: IMAGE_FULL_URL # docker-compose.yml 에서 사용할 환경 변수
           script: |
             aws s3 cp ${{ env.S3_COPY_PATH }} docker-compose.yml
             echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin

diff --git a/.github/workflows/production_deploy.yml b/.github/workflows/production_deploy.yml
@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       semver:
-        description: 'semver without v'
+        description: "semver without v"
         required: true
 
 jobs:
@@ -21,7 +21,7 @@ jobs:
           host: ${{ secrets.EC2_HOST }}
           username: ${{ secrets.EC2_USERNAME }}
           key: ${{ secrets.EC2_PRIVATE_KEY }}
-          envs: IMAGE_FULL_URL  # docker-compose.yml 에서 사용할 환경 변수
+          envs: IMAGE_FULL_URL # docker-compose.yml 에서 사용할 환경 변수
           script: |
             echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin
             docker pull ${{ env.IMAGE_FULL_URL }}

diff --git a/.github/workflows/pull_request_gradle_build.yml b/.github/workflows/pull_request_gradle_build.yml
@@ -1,8 +1,8 @@
-name : Check Style and Test to Develop
+name: Check Style and Test to Develop
 
 on:
   pull_request:
-    branches: [ "develop" ]
+    branches: ["develop"]
 
 jobs:
   build-test:

diff --git a/build.gradle b/build.gradle
@@ -91,7 +91,7 @@ jar {
 
 spotless {
     format 'misc', {
-        target '**/*.yml', '**/*.gradle', '**/*.md'
+        target '**/*.gradle', '**/*.md'
         trimTrailingWhitespace()
         indentWithSpaces(4)
         endWithNewline()
@@ -102,6 +102,11 @@ spotless {
         palantirJavaFormat()
         formatAnnotations()
     }
+
+    yaml {
+        target '**/*.yml'
+        prettier()
+    }
 }
 
 tasks.register('updateGitHooks', Copy) {