본문 바로가기
기타개발/GitHub Actions

GitHub Actions #4 - Managing a workflow run

by 궝테스트 2020. 3. 27.

# GitHub Actions 번역하며 요약하기

https://help.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run

 

Managing a workflow run - GitHub Help

Managing a workflow run You can view the status and results of each step in your workflow, cancel a pending workflow, debug and re-run a failed workflow, search and download logs, and download artifacts. GitHub Actions is available with GitHub Free, GitHub

help.github.com

  • 워크플로우에서 각 step 의 상태와 결과를 확인할 수 있다
  • 보류중인 워크플로우를 취소하고 실패한 워크플로우를 디버그, 재실행, 로그 검색 및 산출물을 다운로드 할 수 있다
  • 아래 내용과 관련된 이미지는 위 깃헙 액션 페이지에서 확인 가능

 

0. About workflow permissions

  • 깃헙에 로그인하고 워크플로우의 레파지토리에 읽기 권한이 있는 경우 워크플로우에 대한 모든 정보를 볼 수 있다
  • 읽기 권한을 통해 산출물을 다운로드하고 워크플로우 파일을 보고, 히스토리 및 로그를 실행할 수 있다 
  • 워크플로우 실행을 취소하거나 재실행하려면 쓰기 권한이 있어야 한다

 

1. About workflow management

  • 워크플로우 실행 페이지에서 진행/완료 여부를 확인할 수 있다
  • 실행이 진행중이면 취소할 수 있다
  • 실행이 완료되면 success, failure, canceled, neutral 의 결과를 확인할 수 있다
  • 실행이 실패한 경우, 워크플로우의 실패를 진단하고 재실행하기위한 빌드 로그를 볼 수 있다
  • 로그를 다운로드 하거나 산출물을 빌드하는 것도 가능하다

 

  • 깃헙 액션은 Checks API 를 사용하여 워크플로우의 상태, 결과, 로그를 출력한다
  • 깃헙은 각 워크플로우의 실행을 위해 새로운 체크 세트를 생성한다
  • 체크 세트는 워크플로우의 각 job 의 실행 체크가 포함되고 각 job 에는 step 이 포함되어 있다
  • 깃헙 액션은 워크플로우의 한 step 으로 실행된다

 

2. Viewing your workflow history

  • 워크플로우 실행의 각 job 과 각 step 을 볼 수 있다
  • 모든 job 에는 기본적으로 'Set up Job' step,  'Complete job' step 과 워크플로우 파일에 설정된 action 이 포함된다

 

3. Viewing logs to diagnose failures

  • 워크플로우 실행이 실패하면 어느 step 이 실패의 원인인지 확인할 수 있고, 실패한 step 의 빌드 로그를 보고 해결할 수 있다

 

4. Searching logs

  • 빌드 로그에서 특정 step 을 검색할 수 있다
  • 로그를 검색할 때 확장된 step 만 결과에 포함된다

 

5. Downloading logs

  • 워크플로우 실행에서 로그 파일을 다운로드 할 수 있다
  • 워크플로우의 산출물도 다운가능하며 자세한 정보는 'Persisting workflow data using artifacs' 에서 확인

 

6. Enabling debug logging

  • 워크플로우 로그가 워크플로우, job, step 이 예상대로 작동하지 않는 이유를 진단하기에 충분한 세부 정보를 제공하지 않는다면, 추가적인 디버그 로그를 사용할 수 있다
  • 추가 로그는 워크플로우가 있는 레파지토리에서 암호 설정하여 컨트롤한다

6-1. Enabling runner diagnostic logging

  • runner 로그는 runner 가 action 을 어떻게 실행하는지에 대한 정보를 포함한 추가 로그 파일을 제공한다
  • 로그 아카이브에 두 개의 로그파일이 추가됨
    • 러너 프로세스 로그 : job 실행을 위한 러너 좌표 및 설정 정보를 포함
    • 워커 프로세스 로그 : job 실행 로그
  • 러너 로그를 활성화하려면 워크플로우가 있는 레파지토리에서 ACTIONS_RUNNER_DEBUG = true 로 설정한다
  • 러너 로그를 다운로드하려면, 워크플로우 실행 로그 아카이브를 다운로드한다
  • 러너 로그는 runner-diagnostic-logs 폴더에 있다.

6-2. Enabling step debug logging

  • step 디버그 로그는 job 실행중과 후의 로그의 상세도?? 를 늘린다
  • step 디버그 로그를 활성화하려면 워크플로우가 있는 레파지토리에서 ACTIONS_STEP_DEBUG = true 로 설정한다
  • 암호 설정 후 더 많은 디버그 이벤트가 step 로그에 보여진다 (Viewing logs to diagnose failures)

댓글