#1 - Issue,PullRequest Template 추가, Discord 봇 설정 (#2)

* chore: gitignore 적용 * chore: IssueTemplate 추가 * chore: pullRequestTemplate 추가 * chore: Discord WebHook 추가 * docs: Pull Request Template 변경 * docs: Issue Template Title 수정 * docs: Pull Request Template 수정 * docs: submitted pr review notification 수정
YAPP-Github · Jun 17, 2024 · d98a056 · d98a056
1 parent 262a154
commit d98a056
Show file tree

Hide file tree

Showing 12 changed files with 358 additions and 29 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,28 @@
+name: Feature Report
+description: Request new Feature
+title: "[feature]: "
+labels: ["🌱기능🌱"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        이번 이슈도 파이팅 화이팅 🔥
+  - type: textarea
+    id: new-feature
+    attributes:
+      label: 작업 사항
+      description: 어떤 기능을 추가할건가요?
+    validations:
+      required: true
+  - type: textarea
+    id: todo
+    attributes:
+      label: Todo
+      description: 작업사항을 나누어 작성해주세요!
+      value: |
+        - [ ] todo1
+  - type: textarea
+    id: etc
+    attributes:
+      label: 기타사항
+      description: 추가로 기록이 필요한 경우 작성해주세요!
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,16 @@
+## 1. 🔗 관련 이슈
+<!-- 연관된 이슈를 링크해주세요. -->
+
+## 2. 📄 구현한 내용 또는 수정한 내용
+<!-- 구현 내용을 리뷰어가 확인할 수 있도록 스크린샷 혹은 gif 등을 활용해 자유롭게 보여주세요. -->
+
+## 3. 🙌 추가적으로 알리고 싶은 내용
+
+## 4. 🙄 TODO / 고민하고 있는 것들
+
+## 5. ✅ 배포 Checklist
+<!-- 확인이 된 부분에 모두 [x]로 변경하여 확인했다는 사실을 알려주세요. -->
+
+- [ ] SecretKey 를 업데이트 해주세요
+- [ ] 본인을 Assign 해주세요.
+- [ ] 본인을 제외한 백엔드 개발자를 리뷰어로 지정해주세요.
diff --git a/.github/workflows/opened-issue-notification.yml b/.github/workflows/opened-issue-notification.yml
@@ -0,0 +1,38 @@
+name: Opened Issue Notification
+on:
+  issues:
+    types:
+      - opened
+      - reopened
+
+jobs:
+  create-issue:
+    name: Discord notification
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Issue
+        uses: Ilshidur/[email protected]
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+          DISCORD_USERNAME: Server 사랑의 BOT
+          DISCORD_AVATAR: https://www.notion.so/image/https%3A%2F%2Fi.imgur.com%2FqIqJ0GA.png?table=block&id=232c40c1-598a-4163-bb8d-acf1151cd026&spaceId=4263d120-003b-49f8-8cb5-37585d6fb45d&width=2000&userId=c0125a99-ca81-4e9f-9c32-096f12a6698c&cache=v2
+          DISCORD_EMBEDS: |
+            [
+                { 
+                  "title": "왔어요 왔어~ 새로운 이슈가 왔어요~🥳\n${{ github.event.issue.title }}",
+                  "color": 10478271,
+                  "description": "${{ github.event.issue.html_url }}",
+                  "fields": [
+                    {
+                      "name": "Issue Number",
+                      "value": "#${{ github.event.issue.number }}",
+                      "inline": true
+                    },
+                    {
+                      "name": "Author",
+                      "value": "${{ github.event.issue.user.login }}",
+                      "inline": true
+                    }
+                  ]
+                }
+              ]
diff --git a/.github/workflows/opened-pr-notification.yml b/.github/workflows/opened-pr-notification.yml
@@ -0,0 +1,94 @@
+name: Opend PR Notification
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+    types:
+      - opened
+      - reopened
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: temurin
+          cache: gradle
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build
+
+      - name: Send Success Message
+        if: ${{ success() }}
+        uses: Ilshidur/[email protected]
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+          DISCORD_USERNAME: Server 사랑의 BOT
+          DISCORD_AVATAR: https://www.notion.so/image/https%3A%2F%2Fi.imgur.com%2FqIqJ0GA.png?table=block&id=232c40c1-598a-4163-bb8d-acf1151cd026&spaceId=4263d120-003b-49f8-8cb5-37585d6fb45d&width=2000&userId=c0125a99-ca81-4e9f-9c32-096f12a6698c&cache=v2
+          DISCORD_EMBEDS: |
+            [
+              { 
+                "author": {
+                  "name": "${{ github.event.pull_request.user.login }}",
+                  "url": "https://github.com/pknu-wap/WAPP/blob/main/image/icon.png?raw=true",
+                  "icon_url": "${{ github.event.pull_request.user.avatar_url }}"
+                },
+                "title": "PR 성공, 리뷰 자~ 두 과 자 ~! 🥰🥰 \n#${{ github.event.pull_request.number }} : ${{ github.event.pull_request.title }}",
+                "color": 10478271,
+                "description": "${{ github.event.pull_request.html_url }}",
+                "fields": [
+                  {
+                    "name": "Base Branch",
+                    "value": "${{ github.base_ref }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "Compare Branch",
+                    "value": "${{ github.head_ref }}",
+                    "inline": true
+                  }
+                ]
+              }
+            ]
+
+      - name: Send Failure Message
+        if: ${{ failure() }}
+        uses: Ilshidur/[email protected]
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+          DISCORD_USERNAME: Server 사랑의 BOT
+          DISCORD_AVATAR: https://www.notion.so/image/https%3A%2F%2Fi.imgur.com%2FqIqJ0GA.png?table=block&id=232c40c1-598a-4163-bb8d-acf1151cd026&spaceId=4263d120-003b-49f8-8cb5-37585d6fb45d&width=2000&userId=c0125a99-ca81-4e9f-9c32-096f12a6698c&cache=v2
+          DISCORD_EMBEDS: |
+            [
+              { 
+                "author": {
+                  "name": "${{ github.event.pull_request.user.login }}",
+                  "url": "https://github.com/pknu-wap/WAPP/blob/main/image/icon.png?raw=true",
+                  "icon_url": "${{ github.event.pull_request.user.avatar_url }}"
+                },
+                "title": "PR 실패. 미쿠짱, 10번 아이언 가져와 🏌️‍♀️🏌️‍♀️ \n#${{ github.event.pull_request.number }} : ${{ github.event.pull_request.title }}",
+                "color": 13458524,
+                "description": "${{ github.event.pull_request.html_url }}",
+                "fields": [
+                  {
+                    "name": "Base Branch",
+                    "value": "${{ github.base_ref }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "Compare Branch",
+                    "value": "${{ github.head_ref }}",
+                    "inline": true
+                  }
+                ]
+              }
+            ]
diff --git a/.github/workflows/submitted-pr-review-notification.yml b/.github/workflows/submitted-pr-review-notification.yml
@@ -0,0 +1,90 @@
+on:
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  approved:
+    if: github.event.review.state == 'APPROVED'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Approve Message
+        uses: Ilshidur/[email protected]
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+          DISCORD_USERNAME: Server 사랑의 BOT
+          DISCORD_AVATAR: https://www.notion.so/image/https%3A%2F%2Fi.imgur.com%2FqIqJ0GA.png?table=block&id=232c40c1-598a-4163-bb8d-acf1151cd026&spaceId=4263d120-003b-49f8-8cb5-37585d6fb45d&width=2000&userId=c0125a99-ca81-4e9f-9c32-096f12a6698c&cache=v2
+          DISCORD_EMBEDS: |
+            [
+              {
+                "title": "PR 어프로브, 이건 기천짱의 특급칭찬이야 ~ 😘😘 \\n${{ github.event.pull_request.title }}",
+                "color": 10478271,
+                "description": "${{ github.event.review.html_url }}",
+                "fields": [
+                  {
+                    "name": "Reviewer",
+                    "value": "${{ github.event.review.user.login }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "Comment",
+                    "value": "${{ github.event.review.body }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "State",
+                    "value": "${{ github.event.review.state }}",
+                    "inline": true
+                  }
+                ]
+              }
+            ]
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: add label
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: 🌟머지 해주세요🌟
+
+  commented_or_changes_requested:
+    if: github.event.review.state == 'commented' || github.event.review.state == 'changes_requested'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Comment Message
+        uses: Ilshidur/[email protected]
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+          DISCORD_USERNAME: Server 사랑의 BOT
+          DISCORD_AVATAR: https://github.com/YAPP-Github/24th-App-Team-1-Android/assets/77484719/611fc015-8f91-4645-90c9-2ae9e86d9e7b
+          DISCORD_EMBEDS: |
+            [
+              {
+                "title": "PR 수정 요청, 미쿠짱 똥 가져와 똥 💩💩 \\n${{ github.event.pull_request.title }}",
+                "color": 13458524,
+                "description": "${{ github.event.review.html_url }}",
+                "fields": [
+                  {
+                    "name": "Reviewer",
+                    "value": "${{ github.event.review.user.login }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "Comment",
+                    "value": "${{ github.event.review.body }}",
+                    "inline": true
+                  },
+                  {
+                    "name": "State",
+                    "value": "${{ github.event.review.state }}",
+                    "inline": true
+                  }
+                ]
+              }
+            ]
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: add label
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: ✏️수정 요청✏️
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,92 @@
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml
diff --git a/.idea/sonarlint/issuestore/8/e/8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d b/.idea/sonarlint/issuestore/8/e/8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d
diff --git a/.idea/sonarlint/issuestore/index.pb b/.idea/sonarlint/issuestore/index.pb
diff --git a/.idea/sonarlint/securityhotspotstore/8/e/8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d b/.idea/sonarlint/securityhotspotstore/8/e/8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d