Maven을 사용하여 Java 빌드 및 테스트

GitHub Actions CI(연속 통합) 워크플로를 만들어 Maven을 사용하여 Java 프로젝트를 빌드하고 테스트할 수 있습니다.

이 문서의 내용

소개

이 가이드에서는 Maven 소프트웨어 프로젝트 관리 도구를 사용하여 Java 프로젝트에 대한 CI(연속 통합)를 수행하는 워크플로를 만드는 방법을 보여 줍니다. 만든 워크플로를 사용하면 끌어오기 요청에 커밋할 때 기본 분기에 대한 빌드 또는 테스트 오류가 발생하는 경우를 확인할 수 있습니다. 이 방법은 코드가 항상 정상인지 확인하는 데 도움이 될 수 있습니다. CI 워크플로를 확장하여 파일을 캐시하고 워크플로 실행에서 아티팩트를 업로드할 수 있습니다.

GitHub 호스트 실행기에는 JDK(Java Development Kit) 및 Maven을 포함하는 소프트웨어가 사전 설치된 도구 캐시가 있습니다. JDK 및 Maven용 소프트웨어 및 미리 설치된 버전 목록은 "GitHub 호스팅 실행기 사용"을 참조하세요.

필수 조건

YAML 및 GitHub Actions의 구문에 대해 잘 알고 있어야 합니다. 자세한 내용은 다음을 참조하세요.

Java 및 Maven 프레임워크를 기본적으로 이해하는 것이 좋습니다. 자세한 내용은 Maven 설명서의 Maven 시작 가이드를 참조하세요.

Maven 워크플로 템플릿 사용

빠르게 시작하려면 워크플로 템플릿을 리포지토리의 .github/workflows 디렉터리에 추가합니다.

GitHub은(는) 대부분의 Maven 프로젝트에서 작동하는 Maven 워크플로 템플릿을 제공합니다. 이 가이드의 후속 섹션에서는 이 워크플로 템플릿을 사용자 지정하는 방법에 대한 예시를 제공합니다.

  1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름 아래에서 작업을 클릭합니다.

    "github/docs" 리포지토리의 탭 스크린샷. "작업" 탭은 주황색 윤곽선으로 강조 표시됩니다.

  3. 리포지토리에 워크플로가 이미 있는 경우 새 워크플로를 클릭합니다.

  4. "워크플로 선택" 페이지에는 권장되는 워크플로 템플릿의 선택 항목이 표시됩니다. "Maven을 사용한 Java"를 검색합니다.

  5. "Java with Maven" 워크플로에서 구성을 클릭합니다.

  6. 필요에 따라 워크플로를 편집합니다. 예를 들어 Java 버전을 변경합니다.

  7. 변경 내용 커밋을 클릭합니다.

maven.yml 워크플로 파일이 리포지토리의 .github/workflows 디렉터리에 추가됩니다.

Java 버전 및 아키텍처 지정

워크플로 템플릿은 x64 플랫폼의 경우 OpenJDK 8을 포함하도록 PATH을(를) 설정합니다. 다른 버전의 Java를 사용하거나 다른 아키텍처(x64 또는 x86)를 대상으로 지정하려는 경우 setup-java 작업을 사용하여 다른 Java 런타임 환경을 선택할 수 있습니다.

예를 들어 x64 플랫폼용 Adoptium에서 제공하는 JDK 버전 11을 사용하려면 setup-java 작업을 사용하고 java-version, distribution 및 architecture 매개 변수를 각각 '11', 'temurin' 및 x64로 구성할 수 있습니다.

YAML
steps:
  - uses: actions/checkout@v4
  - name: Set up JDK 11 for x64
    uses: actions/setup-java@v4
    with:
      java-version: '11'
      distribution: 'temurin'
      architecture: x64

자세한 내용은 setup-java 작업을 참조하세요.

코드 빌드 및 테스트

코드를 빌드하고 테스트하기 위해 로컬에서 사용하는 것과 동일한 명령을 사용할 수 있습니다.

워크플로 템플릿은 기본적으로 package 대상을 실행합니다. 기본 Maven 구성에서 이 명령은 종속성을 다운로드하고, 클래스를 빌드하고, 테스트를 실행하고, 클래스를 배포 가능한 형식(예시: JAR 파일)으로 패키지합니다.

다른 명령을 사용하여 프로젝트를 빌드하거나 다른 대상을 사용하려는 경우 이를 지정할 수 있습니다. 예를 들어 pom-ci.xml 파일에 구성된 verify 대상을 실행할 수 있습니다.

YAML
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-java@v4
    with:
      java-version: '17'
      distribution: 'temurin'
  - name: Run the Maven verify phase
    run: mvn --batch-mode --update-snapshots verify

종속성 캐싱

종속성을 캐시하여 워크플로 실행 속도를 향상할 수 있습니다. 성공적으로 실행되면 로컬 Maven 리포지토리가 캐시에 저장됩니다. 이후 워크플로 실행에서는 캐시가 복원되어 원격 Maven 리포지토리에서 종속성을 다운로드할 필요가 없습니다. setup-java 작업을 사용하여 종속성을 캐시하거나 사용자 지정 및 고급 구성을 위해 cache 작업을 사용할 수 있습니다.

YAML
steps:
  - uses: actions/checkout@v4
  - name: Set up JDK 11
    uses: actions/setup-java@v4
    with:
      java-version: '17'
      distribution: 'temurin'
      cache: maven
  - name: Build with Maven
    run: mvn --batch-mode --update-snapshots verify

이 워크플로는 실행기 홈 디렉터리의 .m2 디렉터리에 있는 로컬 Maven 리포지토리의 콘텐츠를 저장합니다. 캐시 키는 _pom.xml_해시된 콘텐츠이므로 _pom.xml_을 변경하면 캐시가 유효하지 않게 됩니다.

워크플로 데이터를 아티팩트로 패키지

빌드에 성공하고 테스트를 통과한 후에는 그에 따른 Java 패키지를 빌드 아티팩트로 업로드할 수 있습니다. 그러면 워크플로 실행의 일부로 빌드된 패키지를 저장하고 다운로드할 수 있습니다. 아티팩트는 병합되기 전에 로컬 환경에서 끌어오기 요청을 테스트하고 디버그하는 데 도움이 될 수 있습니다. 자세한 내용은 "워크플로에서 데이터 저장 및 공유"을(를) 참조하세요.

Maven은 일반적으로 target 디렉터리에 JAR, EAR 또는 WAR과 같은 출력 파일을 생성합니다. 이를 아티팩트로 업로드하려면 업로드할 아티팩트가 포함된 새 디렉터리에 복사하면 됩니다. staging터 그런 다음 upload-artifact 작업을 사용하여 해당 디렉터리의 콘텐츠를 업로드할 수 있습니다.

YAML
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-java@v4
    with:
      java-version: '17'
      distribution: 'temurin'
  - run: mvn --batch-mode --update-snapshots verify
  - run: mkdir staging && cp target/*.jar staging
  - uses: actions/upload-artifact@v4
    with:
      name: Package
      path: staging