GitHub Action - Build 실패: Spring Boot profile

📎  GitHub Action Build 실패 : Spring Boot profile

 

현재 프로젝트에서 개발 & 운영계로 properties 파일을 분리해주었습니다.

 

기존에 application.properties 에 모두 포함되어 있던 환경 변수(DB정보)들을 개발(dev) & 운영(prod) 파일로 분리를 해주었습니다.

 

그에 따라 지난번에 적용한 GitHub Action을 통해 Build가 실패하는 현상이 발생했습니다.

 

Database의 정보를 읽어올 수 없으니 Build도 당연히 실패하게 됩니다.

따라서 github-action.yml 파일의 Maven build 과정의 코드를 수정합니다.

 

 

 

-Pprod: profile로 prod를 사용

코드에 작성한 Maven 옵션에 대해 간략히 설명드리면 다음과 같습니다.

• -B : 비 대화식 (일괄 처리) 모드에서 실행
• package : 컴파일 수행 및 컴파일한 소스를 packaging 양식(war 혹은 jar)에 맞춰 프로젝트 내 지정한 경로의 디렉토리에 생성
• --file : POM 파일(또는 pom.xml 파일이 존재하는 디렉토리)를 사용하도록 설정

(mvnw과 ./mvnw 의 경로도 찾을 수 없다고 나와서 mvn으로 해결을 했습니다.. 😭)

 

 

현재 pom.xml 은 back 디렉토리의 하위에 존재하기 때문에 back/pom.xml 으로 설정을 잡아줍니다.

그 후 -Pprod 명령어를 통해 profile을 prod로 설정하면,

application-prod.properties 파일을 읽기 때문에 정상적으로 Build가 성공합니다.

 

 

 

 

전체 코드는 다음과 같습니다.

 

pom.xml 

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.4.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.github.oneline</groupId>
	<artifactId>oneline-course</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>oneline-course</name>
	<description>Demo project for Spring Boot</description>
	<properties>
		<java.version>11</java.version>
	</properties>

	<dependencies>
        ... 생략
	</dependencies>

	<!-- profile 추가: dev, prod -->
	<profiles>
		<profile>
			<id>dev</id>
			<properties>
				<environment>dev</environment>
				<maven.test.skip>true</maven.test.skip>
			</properties>
		</profile>
		<profile>
			<id>prod</id>
			<properties>
				<environment>prod</environment>
				<maven.test.skip>true</maven.test.skip>
			</properties>
		</profile>
	</profiles>

	<!-- profile 수정 -->
	<build>
		<sourceDirectory>src/main/java</sourceDirectory>
		<resources>
			<resource>
				<directory>src/main/resources</directory>
				<filtering>true</filtering>
				<excludes>
					<exclude>**/*.java</exclude>
				</excludes>
			</resource>
			<resource>
				<directory>src/main/resources-${environment}</directory>
			</resource>
		</resources>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<excludes>
						<exclude>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
						</exclude>
					</excludes>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>

 

 

 

github-action.yml

# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Oneline-GitHub Action

on: # 이벤트 감지, 워크플로우를 실행시키는 조건 설정
  push:
    branches: [ main ] # push 되면 실행될 브랜치 선택(main)
  pull_request:
    branches: [ main ] # push 되면 실행될 브랜치 선택(main)

jobs: # job - 하나의 인스턴스에서 여러 Step을 그룹시켜 실행하는 역할, 병렬로 실행
  build:
    runs-on: ubuntu-latest

    steps: # 순차적으로 명령어 수행

      # Caching dependencies
      - name: Cache Maven packages
        uses: actions/cache@v2
        with:
          path: ~/.m2
          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
          restore-keys: ${{ runner.os }}-m2

      - name: Checkout
        uses: actions/checkout@v2

      - name: Set up JDK 11
        uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'adopt'

      # build
      - name: Build with Maven
        run: mvn -B package --file back/pom.xml -Pprod

      # time
      - name: Get Current Time
        uses: 1466587594/get-current-time@v2
        id: current-time
        with:
          format: YYYY-MM-DDTHH:mm:ss
          utcOffset: "+09:00" # 기준이 UTC 이므로 한국시간인 KST 로 맞추기 위해 9시간을 더해준다

      # print time
      - name: Print Current Time
        run: echo "Current Time=${{steps.current-time.outputs.formattedTime}}" # current-time 에서 지정한 포맷대로 현재 시간 출력
        shell: bash

 

 

References

• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun
• http://maven.apache.org/ref/3.6.3/maven-embedder/cli.html