GitHub Actions, API 호출로 워크플로우 실행 ID를 바로 확인하세요!
GitHub Actions Workflow Dispatch API를 통해 워크플로우 실행 시, 실행 관련 메타데이터를 반환하는 기능이 추가됨
`return_run_details` 파라미터를 통해 워크플로우 ID, API URL, 워크플로우 URL을 포함한 200 OK 응답을 받을 수 있음
GitHub CLI v2.87.0부터 `gh workflow run` 명령어를 통해 워크플로우 실행 URL을 반환하며, 실행 추적(Run Tracking) 편의성을 제공함
API 응답 개선: 204 No Content에서 200 OK로
기존에는 GitHub Actions Workflow Dispatch API 호출 시, 워크플로우 실행 정보를 얻기 위해 별도의 폴링(Polling) 또는 커스텀 트래킹 솔루션(Custom Tracking Solution) 구축이 필요했다.
`return_run_details` 파라미터: API 호출 결과로 워크플로우 ID, API URL, 워크플로우 URL을 반환하여 실행 정보 접근성(Run Information Accessibility) 향상
200 OK 응답: API 응답 코드를 통해 성공 여부(Success Status)를 즉시 확인 가능
기존 API 호환성: 파라미터 미설정 시, 기존과 동일하게 204 No Content 반환
결과적으로 API 호출 후, 워크플로우 실행 정보를 얻기 위한 개발자 편의성(Developer Convenience)이 크게 개선되었다.
GitHub CLI를 통한 워크플로우 실행
GitHub CLI v2.87.0부터 `gh workflow run` 명령어를 통해 워크플로우를 실행하고, 실행된 워크플로우의 URL을 반환한다.
`gh run view` 명령어: 반환된 URL을 통해 실행 상세 정보(Run Details)를 CLI에서 바로 확인 가능
CLI 통합: API 호출과 CLI 명령어 간의 일관된 경험(Consistent Experience) 제공
자동화 스크립트(Automation Script) 활용: CLI를 통해 워크플로우 실행 및 결과 확인을 자동화(Automation)하여 생산성 향상
CLI 지원을 통해 개발자는 API 호출 외에도 다양한 방식으로 워크플로우를 실행하고, 실행 결과를 확인할 수 있게 되었다.
API 개선의 파급 효과
이번 업데이트를 통해 개발자는 API 호출과 워크플로우 실행 간의 연결성(Connectivity)을 강화하고, 워크플로우 실행 정보를 더욱 효율적으로 관리할 수 있게 되었다.
실행 추적 간소화: 별도의 트래킹 솔루션 구축 없이 API 응답만으로 실행 ID 확인 가능
디버깅 효율성 증대: 워크플로우 실행 실패 시, API URL을 통해 문제 해결(Troubleshooting) 시간 단축
CI/CD 파이프라인(CI/CD Pipeline) 통합: 워크플로우 실행 및 결과 확인을 자동화하여 CI/CD 파이프라인 효율성 증대
결과적으로 개발 생산성 향상과 더불어, GitHub Actions 생태계(Ecosystem) 전반의 효율성 증대를 기대할 수 있다.
