From 3c2c84ec00f568bd2422c72b283d2db98603e4a5 Mon Sep 17 00:00:00 2001 From: Kim Dae Hwi <121790935+marooo326@users.noreply.github.com> Date: Sun, 28 Jan 2024 22:42:00 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20=ED=85=9C=ED=94=8C?= =?UTF-8?q?=EB=A6=BF=20=EC=88=98=EC=A0=95=20=EB=B0=8F=20README.md=20?= =?UTF-8?q?=EC=97=90=20=EC=BB=A4=EB=B0=8B=20=EC=BB=A8=EB=B2=A4=EC=85=98=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80=20(#61)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\342\231\273\357\270\217-refactor.md" | 2 +- .../ISSUE_TEMPLATE/\342\234\250-feat.md" | 6 +- .../ISSUE_TEMPLATE/\360\237\220\233-fix.md" | 8 +- .../\360\237\221\267\357\270\217-ci.md" | 2 +- .../\360\237\223\235\357\270\217-docs.md" | 2 +- .github/workflows/gradle.yml | 115 ------------------ README.md | 18 ++- 7 files changed, 26 insertions(+), 127 deletions(-) rename ".github/ISSUE_TEMPLATE/\342\234\250-feature.md" => ".github/ISSUE_TEMPLATE/\342\234\250-feat.md" (74%) rename ".github/ISSUE_TEMPLATE/\360\237\220\233-bug.md" => ".github/ISSUE_TEMPLATE/\360\237\220\233-fix.md" (54%) delete mode 100644 .github/workflows/gradle.yml diff --git "a/.github/ISSUE_TEMPLATE/\342\231\273\357\270\217-refactor.md" "b/.github/ISSUE_TEMPLATE/\342\231\273\357\270\217-refactor.md" index 6dc256ba..fa2fb7e0 100644 --- "a/.github/ISSUE_TEMPLATE/\342\231\273\357\270\217-refactor.md" +++ "b/.github/ISSUE_TEMPLATE/\342\231\273\357\270\217-refactor.md" @@ -1,7 +1,7 @@ --- name: "♻️ REFACTOR" about: 리팩토링 템플릿입니다. -title: "️♻️ [REFACTOR]" +title: "️♻️ refactor: " labels: refactor assignees: '' diff --git "a/.github/ISSUE_TEMPLATE/\342\234\250-feature.md" "b/.github/ISSUE_TEMPLATE/\342\234\250-feat.md" similarity index 74% rename from ".github/ISSUE_TEMPLATE/\342\234\250-feature.md" rename to ".github/ISSUE_TEMPLATE/\342\234\250-feat.md" index 06120c17..ad636a17 100644 --- "a/.github/ISSUE_TEMPLATE/\342\234\250-feature.md" +++ "b/.github/ISSUE_TEMPLATE/\342\234\250-feat.md" @@ -1,8 +1,8 @@ --- -name: "✨ FEATURE" +name: "✨ FEAT" about: 기능 개발 이슈템플릿입니다. -title: "✨ [FEATURE]" -labels: feature +title: "✨ feat: " +labels: feat assignees: '' --- diff --git "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug.md" "b/.github/ISSUE_TEMPLATE/\360\237\220\233-fix.md" similarity index 54% rename from ".github/ISSUE_TEMPLATE/\360\237\220\233-bug.md" rename to ".github/ISSUE_TEMPLATE/\360\237\220\233-fix.md" index 8880b317..87b955d8 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\220\233-fix.md" @@ -1,8 +1,8 @@ --- -name: "🐛 BUG" -about: 버그 템플릿입니다. -title: "🐛 [BUG]" -labels: bug +name: "🐛 FIX" +about: 버그 수정 템플릿입니다. +title: "🐛 fix: " +labels: fix assignees: '' --- diff --git "a/.github/ISSUE_TEMPLATE/\360\237\221\267\357\270\217-ci.md" "b/.github/ISSUE_TEMPLATE/\360\237\221\267\357\270\217-ci.md" index ca935f65..1b7245af 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\221\267\357\270\217-ci.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\221\267\357\270\217-ci.md" @@ -1,7 +1,7 @@ --- name: "👷 CI" about: 배포 작업 템플릿입니다. -title: "👷 [CI]" +title: "👷 ci: " labels: ci assignees: '' diff --git "a/.github/ISSUE_TEMPLATE/\360\237\223\235\357\270\217-docs.md" "b/.github/ISSUE_TEMPLATE/\360\237\223\235\357\270\217-docs.md" index 00e6f008..bdc76441 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\223\235\357\270\217-docs.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\223\235\357\270\217-docs.md" @@ -1,7 +1,7 @@ --- name: "📝 DOCS" about: 문서 작업 템플릿입니다. -title: "📝 [DOCS]" +title: "📝 docs: " labels: docs assignees: '' diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml deleted file mode 100644 index 7c303a6c..00000000 --- a/.github/workflows/gradle.yml +++ /dev/null @@ -1,115 +0,0 @@ -#name: Java CI/CD with Gradle -# -#on: -# pull_request: -# branches: [ "develop" ] -# push: -# branches: [ "develop" ] -# -#jobs: -# ci: -# runs-on: ubuntu-latest -# steps: -# - name: Checkout -# uses: actions/checkout@v3 -# - name: Set up JDK 17 -# uses: actions/setup-java@v3 -# with: -# -# java-version: '17' -# distribution: 'temurin' -# -# - name: 2) Convert to prod config -# run: | -# cd ./src/main/resources -# [ -e "application.yml" ] && rm application.yml -# echo "spring:" > application.yml -# echo " profiles:" >> application.yml -# echo " active: prod" >> application.yml -# -# - name: 3) Set prod.yml -# uses: microsoft/variable-substitution@v1 -# with: -# files: ./src/main/resources/application-prod.yml -# env: -# spring.datasource.url: ${{ secrets.DB_URL }} -# spring.datasource.username: ${{ secrets.DB_USERNAME }} -# spring.datasource.password: ${{ secrets.DB_PW }} -# spring.jwt.secret: ${{ secrets.JWT_SECRET }} -# spring.jwt.token.access-expiration-time: ${{ secrets.JWT_ACCESS_EXPIRATION_TIME }} -# spring.jwt.token.refresh-expiration-time: ${{ secrets.JWT_REFRESH_EXPIRATION_TIME }} -# spring.data.redis.host: ${{ secrets.REDIS_HOST }} -# spring.data.redis.port: ${{ secrets.REDIS_PORT }} -# cloud.aws.s3.bucket: ${{ secrets.BUCKET }} -# cloud.aws.region.static: ${{ secrets.REGION }} -# cloud.aws.credentials.accessKey: ${{ secrets.S3_ACCESS_KEY }} -# cloud.aws.credentials.secretKey: ${{ secrets.S3_SECRET_KEY }} -# -# - name: 3) Set prod.yml - Debug -# run: | -# cat ./src/main/resources/application-prod.yml -# -# - name: Grant execute permission for gradlew and build -# run: | -# chmod +x ./gradlew -# ./gradlew clean -# ./gradlew build -x test -# -# # Docker image Build (1) -# - name: Docker image build -# run: docker build -t ${{ secrets.DOCKER_USERNAME }}/sponus-docker --pull --no-cache --platform linux/amd64 . -# -# # DockerHub Login (2) -# - name: Docker login -# uses: docker/login-action@v2 -# with: -# username: ${{ secrets.DOCKER_USERNAME }} -# password: ${{ secrets.DOCKER_PASSWORD }} -# -# # Docker Hub push (3) -# - name: Docker Hub push -# run: docker push ${{ secrets.DOCKER_USERNAME }}/sponus-docker -# -# cd: -# runs-on: ubuntu-latest -# needs: ci -# -# steps: -# - name: Checkout -# uses: actions/checkout@v3 -# -# - name: Set up JDK 17 -# uses: actions/setup-java@v3 -# with: -# java-version: '17' -# distribution: 'temurin' -# -# # DockerHub Login (2) -# - name: Docker login -# uses: docker/login-action@v2 -# with: -# username: ${{ secrets.DOCKER_USERNAME }} -# password: ${{ secrets.DOCKER_PASSWORD }} -# -# # AWS EC2 Server Connect & Docker command execution -# - name: Deploy -# uses: appleboy/ssh-action@master -# with: -# host: ${{ secrets.HOST }} # EC2 instance public DNS -# username: ec2-user -# key: ${{ secrets.PRIVATE_KEY }} # pem key -# script: | -# sudo docker stop sponus-docker -# sudo docker rm sponus-docker -# sudo docker rmi ${{ secrets.DOCKER_USERNAME }}/sponus-docker -# sudo docker pull ${{ secrets.DOCKER_USERNAME }}/sponus-docker -# -# sudo docker stop my-redis -# sudo docker rm my-redis -# sudo docker rmi redis -# -# sudo docker pull redis -# sudo docker network create my-network -# sudo docker run --name my-redis --network my-network -d redis -# sudo docker run -e SPRING_PROFILES_ACTIVE=prod -it -d -p 8080:8080 --name sponus-docker -e TZ=Asia/Seoul --network my-network ${{ secrets.DOCKER_USERNAME }}/sponus-docker -# diff --git a/README.md b/README.md index fe5e1b34..d6307667 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ # Contributors - | 앤디/이유제 | 마루/김대휘 | 소피/이소정 | 세헌/호세헌 | 태태/권정태 | |:------------------------------------------------------:|:----------------------------------------------------------:|:------------------------------------------------------:|:--------------------------------------------------------:|:----------------------------------------------------:| | Part Lead / Server Developer | Server Developer | Server Developer | Server Developer | Server Developer | |
[dbwp031](https://github.com/dbwp031)
|
[marooo326](https://github.com/marooo326)
|
[xxoznge](https://github.com/xxoznge)
|
[seheonnn](https://github.com/seheonnn)
|
[oxdjww](https://github.com/oxdjww)
| +### 커밋컨벤션 - +| 태그이름 | 내용 | +|----------------------------|---------------------------------------------| +| :sparkles: `feat` | 새로운 기능을 추가할 경우 | +| :bug:`fix ` | 버그를 고친 경우 | +| :bug:`!hotfix` | 급하게 치명적인 버그를 고쳐야하는 경우 | +| `style` | 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우 | +| :recycle:`refactor` | 코드 리팩토링 | +| :memo:`comment` | 필요한 주석 추가 및 변경 | +| :memo:`docs` | 문서, Swagger 를 수정한 경우 | +| :hammer:`test` | 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X) | +| `chore` | 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X) | +| `rename` | 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 | +| `remove` | 파일을 삭제하는 작업만 수행한 경우 | +| :construction_worker: `ci` | 배포 방식 수정 및 새로 추가 | +| :green_heart: `ci` | 기존 배포 스크립트 수정 |