Skip to main content
Skip to content

이슈 상태 웹후크 및 워크플로

웹후크 및 GitHub Actions 워크플로를 사용하여 문제 상태가 변경되면 대응할 수 있습니다.

참고

문제 상태는 미리 보기에 있으며 프리뷰에 등록된 계정에서만 사용할 수 있습니다. 웹후크 페이로드 및 status_changed 활동 유형은 변경될 수 있습니다.

상태 변경 이벤트 정보

문제의 상태가 변경되면 GitHub가 status_changed webhook event를 issues action과 함께 보냅니다. 모든 issues 작업에 대한 페이로드에는 문제의 현재 상태도 포함됩니다 issue.status. 이러한 이벤트를 사용하여 다른 도구를 문제와 동기화하거나 문제가 특정 상태에 도달하면 워크플로를 실행할 GitHub Actions 수 있습니다.

상태는 문제 상태를 사용하는 리포지토리의 문제에 대해서만 포함됩니다. 다른 문제의 경우 페이로드에는 issue.status이(가) 포함되지 않으며, GitHub은(는) status_changed을(를) 전송하지 않습니다.

전체 페이로드 스키마는 웹후크 이벤트 및 페이로드을 참조하세요.

상태 개체

웹후크 페이로드는 세 가지 속성이 있는 개체로 각 상태를 설명합니다.

PropertyTypeDescription
idInteger상태의 식별자입니다.
nameString상태의 표시 이름(예: In progress.) 이름은 변경될 수 있습니다.
categoryString상태의 범주(예: backlog, planned, started, completed``not_planned또는 duplicate. 나중에 더 많은 범주가 추가될 수 있습니다.

둘 이상의 상태가 동일한 범주에 속할 수 있습니다. 예를 들어 진행 중 및 검토 중 둘 다 started 범주에 속합니다. 코드 또는 워크플로에서 상태 하나를 일치시키려면 해당 id를 사용합니다. 범주의 모든 상태와 일치시키려면 해당 category를 사용합니다. name에서 일치시키지 마세요.

issue.status는 문제가 상태가 없을 때 null입니다. 예를 들어 리포지토리에서 상태를 사용할 수 있기 전에 생성된 문제는 다른 사용자가 상태를 설정하거나 문제를 닫거나 다시 열 때까지 상태가 없습니다.

status_changed 페이로드

issue, repository, sender 및 모든 issues 페이로드에 포함된 다른 속성 외에도 status_changed 페이로드에는 다음 속성이 포함됩니다. 이 작업의 경우 sender는 상태를 변경한 사용자 또는 앱입니다.

PropertyDescription
status문제가 변경된 상태
changes.status.from변경 전 문제의 상태 또는 이전 상태가 없으면 null
changes.state.from
문제의 이전 state, open 또는 closed. 상태 변경이 문제를 닫거나 다시 연 경우에만 포함됩니다.
changes.state_reason.from문제의 이전 state_reason 입니다. 상태 변경이 상태 이유를 변경한 경우에만 포함됩니다(예: 문제를 닫거나 다시 열거나 닫힌 이유를 변경하는 경우).
이슈에 상태 이유가 없는 경우(예: 처음 닫힌 경우)에는 null입니다.

캡처된 값 및 현재 이슈

changes 및 status 속성은 저장 당시의 변경 사항을 설명합니다. issue를 포함한 이 issue.status 속성은 다른 모든 issues 작업과 마찬가지로 배포가 빌드되었을 때의 문제를 설명합니다. 그 전에 문제가 다시 변경되면 issue.status는 status와 다를 수 있습니다. 예를 들어 누군가가 문제를 진행 중에서 검토 중으로 이동한 다음 곧바로 완료로 이동하는 경우, 첫 번째 변경의 전달에는 issue.status 값이 완료일 수 있습니다.

특정 변경이 수행된 작업을 확인하려면 다음을 사용합니다 status changes. 지연, 재시도 또는 다시 배달된 페이로드는 오래되었을 수 있으므로 issue.status는 문제의 최신 상태가 아닐 수 있습니다. 자세한 내용은 이 문서의 뒷부분에 있는 Delivery를 참조하세요.

status_changed이(가) 전송되는 시기

GitHub 는 status_changed 문제가 생성, 닫힘 또는 다시 열릴 때 발생하는 GitHub 변경 내용을 포함하여 문제의 상태가 변경될 때마다 보냅니다.

  • 상태 설정: 사용자가 문제에 대해 다른 상태를 선택합니다.
  • 문제 만들기: 새 문제는 문제를 만드는 사람이 다른 상태를 선택하지 않는 한 백로그 상태를 가져옵니다. changes.status.from은 null입니다. GitHub은 opened뿐만 아니라 status_changed도 보냅니다.
  • 첫 상태 설정: 상태가 없는 기존 이슈에 상태가 하나 부여됩니다. changes.status.from은 null입니다.
  • 이슈 닫기 또는 다시 열기: 이슈를 완료됨으로 닫으면 완료 상태가 설정되고, 계획되지 않음으로 닫으면 계획되지 않음 상태가 설정되며, 중복으로 닫으면 중복 상태가 설정됩니다. 상태를 선택하지 않고 문제를 다시 열면 백로그가 설정됩니다. GitHub은(는) closed 또는 reopened와(과) status_changed도 보냅니다.
  • 끌어오기 요청 연결: 열려 있는 끌어오기 요청을 상태가 없거나 Backlog 또는 Todo 상태가 있는 열린 문제에 연결하면 문제가 진행 중으로 이동합니다. sender 는 끌어오기 요청을 연결한 사용자 또는 앱입니다. 문제에 대한 상태를 선택할 수 없는 경우 상태는 변경되지 않습니다.

GitHub은 다음 경우에 status_changed을(를) 보내지 않습니다.

  • 상태가 변경되지 않습니다(예: 문제에 이미 설정된 상태를 선택하는 경우).
  • 이 문제는 다른 리포지토리로 전송됩니다. 새 문제는 상태를 유지하며, 이 상태는 transferred 페이로드에 changes.new_issue.status 포함됩니다.

문제를 닫거나 다시 여는 상태 변경

not_planned, duplicate, completed 범주의 상태는 닫힌 문제에 대한 것입니다. 열려 있는 문제에 대해 이러한 상태 중 하나를 선택하면 문제가 닫히고 닫힌 문제에 대한 다른 범주에서 상태를 선택하면 다시 열립니다.

상태 변경으로 인해 문제가 닫히거나 다시 열리면 GitHub에서는 두 개의 전달을 보냅니다: closed, 그리고 reopened 또는 status_changed. 두 배달은 어느 쪽이 먼저든 도착할 수 있습니다.

닫힌 문제를 예를 들어 완료에서 계획되지 않음으로처럼 다른 닫힘 사유가 있는 상태로 변경하면, changes.state_reason은(는) 포함하지만 changes.state은(는) 포함하지 않은 status_changed을(를) 보냅니다. GitHub 또한 새 closed가 포함된 다른 state_reason 전달도 보냅니다.

통합이 status_changed뿐만 아니라 closed 또는 reopened도 처리하는 경우, 동일한 변경 내용이 두 전달 모두에서 보고될 수 있으므로 이를 처리할 수 있는지 확인하세요.

배달

GitHub는 다른 웹후크 이벤트와 동일한 방식으로 status_changed를 전달합니다. 전달은 최선을 다해 이루어집니다. GitHub 에서는 각 변경 내용이 정확히 한 번 전달되거나 해당 배달이 변경이 발생한 순서대로 도착한다고 보장하지 않습니다.

  • 배달 실패: 예를 들어 서버를 사용할 수 없는 경우 배달이 실패할 수 있습니다. GitHub는 실패한 배달을 자동으로 다시 배달하지는 않지만 다시 배달할 수 있습니다. 자세한 내용은 실패한 웹후크 제공 처리하기을(를) 참조하세요.
  • 반복된 배달: 동일한 배달을 두 번 이상 받을 수 있습니다(예: 다시 배달될 때). 다시 배달에는 원래 배달과 동일한 X-GitHub-Delivery 헤더가 있으므로 헤더를 사용하여 이미 처리한 배달을 건너뛸 수 있습니다.
  • 주문: 배달이 순서에 맞지 않게 도착할 수 있으며, 지연되거나 재시도되거나 다시 배달된 페이로드는 issue.status를 포함해 오래된 것일 수 있습니다. 전달이 도착하는 순서를 사용하여 이슈의 최신 상태를 결정하지 마세요.

문제의 최신 상태를 가져오려면 REST API를 사용하여 문제를 가져오세요. 자세한 내용은 이슈에 대한 REST API 엔드포인트을(를) 참조하세요. 조직이 소유한 리포지토리에서 응답에는 GitHub App 설치로 인증된 요청과 워크플로에서 status을(를) 사용하는 요청을 포함하여 모든 인증된 요청에 GITHUB_TOKEN이(가) 포함됩니다. 미리 보기 동안 개인 계정이 소유한 리포지토리에서는 미리 보기에 액세스할 수 있는 사용자를 대신하여 요청이 이루어진 경우에만 응답에 status이 포함됩니다. 응답에 포함되지 status않은 경우 나중에 도착하는 배달이 이전 상태를 전달할 수 있으므로 배달 상태를 주의해서 사용합니다.

상태를 변경할 수 있는 사람

리포지토리에 대한 분류 권한 이상이 있는 사용자는 해당 이슈의 상태를 선택할 수 있습니다. 사용자 지정 역할, 앱, 워크플로 및 개인 계정에 대한 추가 권한 규칙이 적용됩니다:

  • 사용자 지정 리포지토리 역할: 조직 소유의 리포지토리에서 심사, 쓰기 또는 유지 관리 역할을 상속하는 사용자 지정 역할을 가진 사용자는 상태를 선택할 수 있습니다. 읽기 역할을 상속하는 사용자 지정 역할을 가진 사용자는 역할에서 문제 유형을 설정할 수 있더라도 상태를 선택할 수 없습니다.
  • 앱 및 워크플로: 조직 소유 리포지토리에서는 "Issues" 리포지토리 권한에 대한 쓰기 액세스 권한이 있는 GitHub Apps도 상태를 선택할 수 있으며, 여기에는 GITHUB_TOKEN 권한이 있는 issues: write를 사용하는 워크플로도 포함됩니다.
  • 개인 계정: 미리 보기개인 계정이 소유한 리포지토리에서 미리 보기에 액세스할 수 있는 사용자만 상태를 선택할 수 있습니다.

이슈를 닫거나 다시 여는 상태를 선택하려면 이슈를 닫거나 다시 열 수 있는 권한도 필요합니다. 닫힌 문제가 닫힌 이유를 변경하려면(예: 완료에서 계획되지 않음으로) 문제를 닫고 다시 열 수 있는 권한이 필요합니다.

상태를 선택할 수 없는 사용자는 문제를 닫거나 다시 열어 상태를 변경할 수 있습니다. 예를 들어 문제의 작성자는 리포지토리에 대한 읽기 액세스 권한이 있으면 문제를 닫고 다시 열 수 있습니다. 그러면 새 상태에 대한 기본 상태가 설정됩니다. 이러한 변경 내용은 status_changed도 전송하며, sender은 문제를 닫거나 다시 연 사람입니다.

상태가 변경되면 워크플로 실행

문제의 상태가 변경될 때 GitHub Actions 워크플로를 실행하려면 issues 이벤트의 status_changed 활동 유형을 사용합니다. 워크플로는 문제의 상태가 변경 될 때마다 실행됩니다. 워크플로에서 github.event 컨텍스트의 다음 속성은 변경 사항을 설명합니다.

  • github.event.status에는 문제가 변경된 대상 상태가 포함됩니다.
  • github.event.changes.status.from에는 이전 상태 또는 문제에 이전 상태가 없으면 null가 포함됩니다.
  • github.event.issue.status 에는 페이로드가 빌드되었을 때의 문제 상태가 포함됩니다. 모든 issues 활동 유형에 대한 페이로드는 이 속성을 포함합니다.

중요

status_changed 없이 issues 이벤트를 사용하는 워크플로는 types에 대해서도 실행됩니다. 이러한 워크플로는 누군가 이슈의 상태를 변경할 때마다 실행되며, GitHub가 closed뿐만 아니라 status_changed, opened, 또는 reopened도 전송하므로 이슈가 생성, 종료 또는 다시 열릴 때 한 번 더 실행됩니다. 예기치 않은 실행을 방지하려면 워크플로에 필요한 활동 유형을 나열합니다.

미리 보기 동안 GitHub의 워크플로 편집기와 같이 워크플로 파일의 유효성을 검사하는 편집기는 status_changed를 잘못된 활동 유형으로 보고할 수 있습니다. 이 오류는 무시할 수 있습니다.

상태를 ID로 일치시키고 범주의 모든 상태와 일치하는 예제 워크플로는 워크플로를 트리거하는 이벤트을 참조하세요.

예제 페이로드

다음 발췌문에서는 변경 사항을 설명하는 페이로드의 status_changed 속성을 보여 줍니다. 전체 페이로드에는 전체 issue, repository개체 및 sender 기타 속성도 포함됩니다.

문제 만들기

다른 사용자가 상태를 선택하지 않고 문제를 만들면 문제에 백로그 상태가 지정됩니다. changes.status.from은 null이고, changes에는 state_reason 또는 state이(가) 포함되지 않습니다.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "open",
    "state_reason": null,
    "status": {
      "id": 2,
      "name": "Backlog",
      "category": "backlog"
    }
  },
  "status": {
    "id": 2,
    "name": "Backlog",
    "category": "backlog"
  },
  "changes": {
    "status": {
      "from": null
    }
  }
}

동일한 범주의 상태로 변경

진행 중에서 검토 중으로 문제를 이동해도 해당 상태나 범주는 변경되지 않으므로 changes에는 status만 포함됩니다.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "open",
    "state_reason": null,
    "status": {
      "id": 8,
      "name": "In review",
      "category": "started"
    }
  },
  "status": {
    "id": 8,
    "name": "In review",
    "category": "started"
  },
  "changes": {
    "status": {
      "from": {
        "id": 4,
        "name": "In progress",
        "category": "started"
      }
    }
  }
}

상태를 변경하여 문제 닫기

검토에서 완료로 문제를 이동하면 문제가 닫힙니다. changes.state.from는 open이고, changes.state_reason.from는 해당 문제가 이전에 상태 이유를 갖고 있지 않았기 때문에 null입니다. GitHub 또한 이 변경 내용에 대한 closed 전달을 보냅니다.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "closed",
    "state_reason": "completed",
    "status": {
      "id": 5,
      "name": "Done",
      "category": "completed"
    }
  },
  "status": {
    "id": 5,
    "name": "Done",
    "category": "completed"
  },
  "changes": {
    "status": {
      "from": {
        "id": 8,
        "name": "In review",
        "category": "started"
      }
    },
    "state": {
      "from": "open"
    },
    "state_reason": {
      "from": null
    }
  }
}