diff --git a/.github/workflows/ci-java.yml b/.github/workflows/ci-java.yml index fd55f05f..f3b2b5d5 100644 --- a/.github/workflows/ci-java.yml +++ b/.github/workflows/ci-java.yml @@ -78,6 +78,7 @@ jobs: run: | ./gradlew unitTest ./gradlew integrationTest + ./gradlew javadoc if [ "${{ github.base_ref }}" = "main" ] || [[ "${{ github.ref }}" == refs/tags/* ]]; then ./gradlew e2eTest fi diff --git a/apps/user-service/src/main/java/site/icebang/domain/workflow/mapper/WorkflowHistoryMapper.java b/apps/user-service/src/main/java/site/icebang/domain/workflow/mapper/WorkflowHistoryMapper.java index d22e2a68..aec0bb36 100644 --- a/apps/user-service/src/main/java/site/icebang/domain/workflow/mapper/WorkflowHistoryMapper.java +++ b/apps/user-service/src/main/java/site/icebang/domain/workflow/mapper/WorkflowHistoryMapper.java @@ -10,53 +10,61 @@ import site.icebang.domain.workflow.dto.WorkflowHistoryDTO; import site.icebang.domain.workflow.dto.WorkflowRunDto; +/** + * 워크플로우 실행 히스토리 관련 데이터베이스 매퍼 인터페이스입니다. + * + *

워크플로우, 작업(Job), 태스크(Task)의 실행 기록과 관련된 데이터 조회를 담당합니다. + * + * @author jys01012@gmail.com + * @since v0.0.1-beta + */ @Mapper public interface WorkflowHistoryMapper { /** - * 워크플로우 실행 정보 조회 + * 워크플로우 실행 정보를 조회합니다. * * @param runId workflow_run.id - * @return WorkflowRunDto + * @return 워크플로우 실행 정보 */ WorkflowRunDto selectWorkflowRun(Long runId); /** - * 워크플로우 실행의 Job 목록 조회 + * 워크플로우 실행의 작업 목록을 조회합니다. * * @param workflowRunId workflow_run.id - * @return List + * @return 작업 실행 정보 목록 */ List selectJobRunsByWorkflowRunId(Long workflowRunId); /** - * Job 실행의 Task 목록 조회 + * 작업 실행의 태스크 목록을 조회합니다. * * @param jobRunId job_run.id - * @return List + * @return 태스크 실행 정보 목록 */ List selectTaskRunsByJobRunId(Long jobRunId); /** - * 워크플로우 실행 TraceId 조회 + * 워크플로우 실행 TraceId를 조회합니다. * * @param runId workflow_run.id - * @return String traceId + * @return 추적 ID 문자열 */ String selectTraceIdByRunId(Long runId); /** - * 워크플로우 런 페이지네이션 + * 페이지네이션을 적용한 워크플로우 히스토리 목록을 조회합니다. * - * @param pageParams pageParams - * @return List + * @param pageParams 페이지 매개변수 + * @return 워크플로우 히스토리 정보 목록 */ List selectWorkflowHistoryList(PageParams pageParams); /** - * 워크플로우 런 인스턴스 개수 조회 + * 워크플로우 런 인스턴스의 총 개수를 조회합니다. * - * @param pageParams pageParams - * @return 결과 개수 + * @param pageParams 페이지 매개변수 + * @return 총 결과 개수 */ int selectWorkflowHistoryCount(PageParams pageParams); }