워크플로우 상태 배지 추가하기
워크플로우 상태 배지 추가하기
저장소에 워크플로우의 상태를 나타내는 상태 배지(status badge)를 표시할 수 있어요.
출처: 문서
본문
저장소에 워크플로우의 상태를 나타내는 상태 배지를 표시할 수 있어요.
[!NOTE] 비공개 저장소의 워크플로우 배지는 외부에서 접근할 수 없어서, 외부 사이트에 임베드하거나 링크할 수 없어요.
상태 배지는 워크플로우가 현재 실패 중인지 통과 중인지 보여줘요. 상태 배지를 추가하는 흔한 위치는 저장소의 README.md 파일이지만, 원하는 어떤 웹 페이지에도 추가할 수 있어요. 기본적으로 배지는 기본 브랜치의 상태를 표시합니다. 기본 브랜치에 워크플로우 실행이 없으면 모든 브랜치에서 가장 최근 실행의 상태를 표시해요. URL에서 branch와 event 쿼리 매개변수를 사용해 특정 브랜치나 이벤트의 워크플로우 실행 상태를 표시할 수 있어요.
README.md 파일에 워크플로우 상태 배지를 추가하려면, 먼저 표시하려는 상태 배지의 URL을 찾으세요. 그런 다음 Markdown을 사용해 README.md 파일에서 배지를 이미지로 표시할 수 있어요. Markdown의 이미지 마크업에 대한 자세한 내용은 Basic writing and formatting syntax를 참고하세요.
UI 사용하기
워크플로우 파일 이름, 브랜치 매개변수, 이벤트 매개변수를 사용해 UI에서 직접 워크플로우 상태 배지를 만들 수 있어요.
-
GitHub에서 저장소의 메인 페이지로 이동하세요.
-
저장소 이름 아래에서 Actions을 클릭하세요.
-
왼쪽 사이드바에서 보고 싶은 워크플로우를 클릭하세요.
-
페이지 오른쪽의 "Filter workflow runs" 필드 옆에서 을 클릭해 드롭다운 메뉴를 표시하고 Create status badge를 클릭하세요.
-
선택 사항으로, 기본 브랜치와 다른 브랜치의 상태 배지를 표시하려면 브랜치를 선택하세요.
-
선택 사항으로, 워크플로우를 트리거할 이벤트를 선택하세요.
-
Copy status badge Markdown을 클릭하세요.
-
Markdown을
README.md파일에 복사하세요.
워크플로우 파일 이름 사용하기
워크플로우 파일 이름을 사용해 워크플로우 상태 배지의 URL을 만들 수 있어요:
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
README.md 파일에 워크플로우 상태 배지를 표시하려면 Markdown의 이미지 임베드 마크업을 사용하세요. Markdown의 이미지 마크업에 대한 자세한 내용은 Basic writing and formatting syntax를 참고하세요.
예를 들어 파일 경로가 .github/workflows/main.yml인 워크플로우의 상태 배지를 추가하려면 README.md 파일에 다음 Markdown을 추가하세요. 저장소의 OWNER는 github 조직이고 REPOSITORY 이름은 docs예요.
branch 매개변수 사용하기
특정 브랜치의 워크플로우 실행 상태를 표시하려면 상태 배지 URL 끝에 ?branch=BRANCH-NAME을 추가하세요.
예를 들어 이름이 feature-1인 브랜치의 상태 배지를 표시하려면 README.md 파일에 다음 Markdown을 추가하세요.
event 매개변수 사용하기
push 이벤트로 트리거된 워크플로우 실행의 상태를 표시하려면 상태 배지 URL 끝에 ?event=push를 추가하세요.
예를 들어 push 이벤트로 트리거된 워크플로우 실행의 상태를 표시하는 배지를 추가하려면 README.md 파일에 다음 Markdown을 추가하세요. 이 배지는 해당 브랜치의 현재 상태에 대한 빌드 상태를 보여줍니다.
