BE Deploy

.github/workflows/deploy-all-ci-cd-push.yml → .github/workflows/deploy-be-ci-cd-push.yml

@@ -2,11 +2,11 @@ name: All deploy CI + CD on push
 
 on:
   push:
-    branches: [ "deploy" ]
+    branches: [ "deploy/BE" ]
 
 jobs:
-  deploy-ci-be:
-    runs-on: ubuntu-latest
+  deploy-ci:
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout repository
@@ -45,23 +45,8 @@ jobs:
       - name: Docker Hub Push
         run: docker push 2023batondeploy/2023-baton-deploy
 
-  deploy-ci-fe:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./frontend
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: 의존성을 설치한다
-        run: npm install
-
-      - name: 테스트를 수행한다
-        run: npm run test
-
-  deploy-cd-be:
-    needs: deploy-ci-be
+  deploy-cd:
+    needs: deploy-ci
     runs-on: [self-hosted, Linux, ARM64, deploy]
 
     steps:
@@ -77,4 +62,4 @@ jobs:
 
       - name: Docker Compose
         run: |
-          sudo docker run --name spring-baton -p 8080:8080 2023batondeploy/2023-baton-deploy:latest 1>> build.log 2>> error.log &
+          sudo docker run --name spring-baton -p 8080:8080 -e TZ=Asia/Seoul 2023batondeploy/2023-baton-deploy:latest 1>> build.log 2>> error.log &

.github/workflows/deploy-be-ci-pr.yml

@@ -2,14 +2,11 @@ name: BE deploy CI on Pull Request
 
 on:
   pull_request:
-    branches: [ "deploy" ]
-
-permissions:
-  contents: read
+    branches: [ "deploy/BE" ]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v3

.github/workflows/dev-be-ci-cd-push.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout repository
@@ -62,4 +62,4 @@ jobs:
 
       - name: Docker Compose
         run: |
-          sudo docker run --name spring-baton --network=baton -p 8080:8080 2023baton/2023baton:latest 1>> build.log 2>> error.log &
+          sudo docker run --name spring-baton --network=baton -p 8080:8080 -e TZ=Asia/Seoul 2023baton/2023baton:latest 1>> build.log 2>> error.log &

.github/workflows/dev-be-ci-pr.yml

@@ -4,12 +4,9 @@ on:
   pull_request:
     branches: [ "dev/BE" ]
 
-permissions:
-  contents: read
-
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v3

backend/baton/.gitignore

@@ -180,3 +180,4 @@ gradle-app.setting
 
 src/main/resources/application-deploy.yml
 src/main/resources/application-dev.yml
+src/main/resources/static/docs/**

backend/baton/Dockerfile-deploy

@@ -4,4 +4,4 @@ WORKDIR /app
 
 COPY ./build/libs/baton-0.0.1-SNAPSHOT.jar /app/baton.jar
 
-CMD ["java", "-jar", "-Dspring.profiles.active=deploy", "baton.jar"]
+CMD ["java", "-Duser.timezone=Asia/Seoul", "-jar", "-Dspring.profiles.active=deploy", "baton.jar"]

backend/baton/Dockerfile-dev

@@ -4,4 +4,4 @@ WORKDIR /app
 
 COPY ./build/libs/baton-0.0.1-SNAPSHOT.jar /app/baton.jar
 
-CMD ["java", "-jar", "-Dspring.profiles.active=dev", "baton.jar"]
+CMD ["java", "-Duser.timezone=Asia/Seoul", "-jar", "-Dspring.profiles.active=dev", "baton.jar"]

backend/baton/build.gradle

@@ -15,6 +15,9 @@ java {
 
 configurations {
 	asciidoctorExt
+	configureEach {
+		exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
+	}
 }
 
 configurations {
@@ -29,31 +32,50 @@ repositories {
 
 ext {
 	set('snippetsDir', file("build/generated-snippets"))
+	set('restDocsCopyFrom', file("build/docs/asciidoc/index.html"))
+	set('restDocsCopyIntoBuild', file("build/resources/main/static/docs"))
+	set('restDocsCopyIntoLocal', file("src/main/resources/static/docs"))
 }
 
 dependencies {
+	// spring starter
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-webflux'
+	implementation 'org.springframework.boot:spring-boot-starter-aop:3.1.1'
+
+	// flyway
 	implementation 'org.flywaydb:flyway-core'
 	implementation 'org.flywaydb:flyway-mysql'
+
+	// jwt
 	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
 	runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
 	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
+
+	// lombok
 	compileOnly 'org.projectlombok:lombok'
+	annotationProcessor 'org.projectlombok:lombok'
+
+	// database
 	runtimeOnly 'com.h2database:h2'
 	runtimeOnly 'com.mysql:mysql-connector-j'
+
+	// log
+	implementation 'org.springframework.boot:spring-boot-starter-log4j2'
+
+	// docker
 	developmentOnly 'org.springframework.boot:spring-boot-docker-compose'
-	annotationProcessor 'org.projectlombok:lombok'
+
+	// test
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testImplementation 'io.rest-assured:rest-assured'
 	testImplementation 'org.testcontainers:junit-jupiter'
 	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
 	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
 	testImplementation 'org.testcontainers:mysql'
-
 	asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
 }
 
@@ -73,5 +95,26 @@ tasks.register('copySecret', Copy) {
 tasks.named('asciidoctor') {
 	inputs.dir snippetsDir
 	configurations 'asciidoctorExt'
+	sources {
+		include("**/index.adoc")
+	}
+	baseDirFollowsSourceFile()
 	dependsOn test
 }
+
+asciidoctor.doFirst {
+	delete file(restDocsCopyFrom)
+}
+
+task copyDocument(type: Copy) {
+	dependsOn asciidoctor
+	from file(restDocsCopyFrom)
+	into file(restDocsCopyIntoLocal)
+	into file(restDocsCopyIntoBuild)
+}
+
+tasks.named('resolveMainClassName') {
+	inputs.files(tasks.named('copyDocument'))
+}
+
+bootJar.dependsOn('copyDocument')

backend/baton/src/docs/asciidoc/MemberLoginProfileReadApi.adoc

@@ -0,0 +1,31 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:doctype: book
+:icons: font
+:source-highlighter: highlight.js
+:toc: left
+:toclevels: 3
+:sectlinks:
+:operation-http-request-title: Example Request
+:operation-http-response-title: Example Response
+
+=== *로그인된 사용자 프로필 조회*
+
+==== *로그인된 사용자 프로필 조회 API*
+
+===== *Http Request*
+
+include::{snippets}/../../build/generated-snippets/member-read-with-logined-member-api-test/read-login-member-by-access-token/http-request.adoc[]
+
+===== *Http Request Headers*
+
+include::{snippets}/../../build/generated-snippets/member-read-with-logined-member-api-test/read-login-member-by-access-token/request-headers.adoc[]
+
+===== *Http Response*
+
+include::{snippets}/../../build/generated-snippets/member-read-with-logined-member-api-test/read-login-member-by-access-token/http-response.adoc[]
+
+===== *Http Response Fields*
+
+include::{snippets}/../../build/generated-snippets/member-read-with-logined-member-api-test/read-login-member-by-access-token/response-fields.adoc[]

backend/baton/src/docs/asciidoc/RunnerLoginProfileReadApi.adoc

@@ -0,0 +1,31 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:doctype: book
+:icons: font
+:source-highlighter: highlight.js
+:toc: left
+:toclevels: 3
+:sectlinks:
+:operation-http-request-title: Example Request
+:operation-http-response-title: Example Response
+
+=== *로그인된 러너 프로필 조회*
+
+==== *로그인된 러너 마이페이지 프로필 조회 API*
+
+===== *Http Request*
+
+include::{snippets}/../../build/generated-snippets/runner-read-with-logined-runner-api-test/read-my-profile-by-token/http-request.adoc[]
+
+===== *Http Request Headers*
+
+include::{snippets}/../../build/generated-snippets/runner-read-with-logined-runner-api-test/read-my-profile-by-token/request-headers.adoc[]
+
+===== *Http Response*
+
+include::{snippets}/../../build/generated-snippets/runner-read-with-logined-runner-api-test/read-my-profile-by-token/http-response.adoc[]
+
+===== *Http Response Fields*
+
+include::{snippets}/../../build/generated-snippets/runner-read-with-logined-runner-api-test/read-my-profile-by-token/response-fields.adoc[]

backend/baton/src/docs/asciidoc/RunnerPostCreateApi.adoc

@@ -0,0 +1,27 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:doctype: book
+:icons: font
+:source-highlighter: highlight.js
+:toc: left
+:toclevels: 3
+:sectlinks:
+:operation-http-request-title: Example Request
+:operation-http-response-title: Example Response
+
+=== *러너 게시글 생성*
+
+==== *러너 게시글 생성 API*
+
+===== *Http Request*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post/http-request.adoc[]
+
+===== *Http Request Header*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post/request-headers.adoc[]
+
+===== *Http Response Header*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post/response-headers.adoc[]

backend/baton/src/docs/asciidoc/RunnerPostCreateReadApi.adoc

@@ -0,0 +1,39 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:doctype: book
+:icons: font
+:source-highlighter: highlight.js
+:toc: left
+:toclevels: 3
+:sectlinks:
+:operation-http-request-title: Example Request
+:operation-http-response-title: Example Response
+
+=== *러너 게시글 생성 API*
+
+==== *러너 게시글에 서포터 리뷰 지원 API*
+
+===== *Http Request*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/http-request.adoc[]
+
+===== *Http Request Headers*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/request-headers.adoc[]
+
+===== *Http Request Path Parameters*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/path-parameters.adoc[]
+
+===== *Http Request Fields*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/request-fields.adoc[]
+
+===== *Http Response*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/http-response.adoc[]
+
+===== *Http Response Headers*
+
+include::{snippets}/../../build/generated-snippets/runner-post-create-api-test/create-runner-post-applicant/response-headers.adoc[]

backend/baton/src/docs/asciidoc/RunnerPostDeleteApi.adoc

@@ -0,0 +1,27 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:doctype: book
+:icons: font
+:source-highlighter: highlight.js
+:toc: left
+:toclevels: 3
+:sectlinks:
+:operation-http-request-title: Example Request
+:operation-http-response-title: Example Response
+
+=== *러너 게시글 삭제*
+
+==== *러너 게시글 삭제 API*
+
+===== *Http Request*
+
+include::{snippets}/../../build/generated-snippets/runner-post-delete-api-test/delete-by-runner-post-id/http-request.adoc[]
+
+===== *Http Request Path Parameters*
+
+include::{snippets}/../../build/generated-snippets/runner-post-delete-api-test/delete-by-runner-post-id/path-parameters.adoc[]
+
+===== *Http Response*
+
+include::{snippets}/../../build/generated-snippets/runner-post-delete-api-test/delete-by-runner-post-id/http-response.adoc[]