> For the complete documentation index, see [llms.txt](https://docs.riido.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.riido.io/integrations/github.md).

# 깃허브

<figure><img src="/files/WczIkfe1Fy5o8PYXgSiC" alt=""><figcaption></figcaption></figure>

## 개요

개발자는 코드 개발에 집중해야 합니다. 하지만 실제 개발은 깃허브에서 이루어지지만, 작업 진행 상황은 뤼이도에서 관리되는 이중 구조 때문에, 두 곳을 번갈아 확인해야 하거나 불필요하고 반복적인 수동 업데이트가 강요되었습니다. 이로 인해 작업 상태가 항상 최신이 아니거나, 개발자의 작업 흐름이 끊기는 문제가 발생했습니다.

Github 연동은 이 문제를 완벽하게 해결합니다.

* Github에서 브랜치 생성, 커밋, PR 등이 발생하면 자동으로 뤼이도의 작업 상태가 업데이트됩니다. 개발자는 뤼이도에 들어올 필요가 없어 더 이상 작업 흐름이 끊기지 않습니다.
* 뤼이도에서 작업과 연결된 모든 PR 상태를 확인할 수 있어, Github에 방문하지 않아도 개발 히스토리를 정확하게 파악할 수 있습니다.

이로 인해, 개발자는 Github만 사용해도 작업이 최신 상태로 유지되고, PM은 뤼이도에서 작업의 개발 히스토리를 빠짐없이 확인할 수 있습니다.

## 연동 설정 가이드

Github 연동은 워크스페이스 단위로 설정되며, 연결할 Repository를 지정해야 합니다.

#### 1) 워크스페이스 연동:

1. \[설정 > 워크스페이스 > 외부 연동 > Github] 페이지로 이동합니다.
2. ‘연동하기’ 버튼을 클릭하고, 뤼이도와 연결할 Github Organization을 선택합니다.

#### 2) Repository 연결:

1. Github 설정 업데이트를 통해 뤼이도가 접근할 Repository 권한을 설정합니다. `All repositories` 또는 `Only select repositories` 중 하나를 선택합니다.
2. 권한이 부여된 Repository 중, 뤼이도와 연결할 Repository를 추가합니다.

## 뤼이도와 Github 연결

#### 1. 브랜치 이름에 키 번호를 포함하여 작업과 연결

{% columns %}
{% column %}
**직접 연결**

작업할 브랜치 이름에 `키 번호` (예: ID-1234) 를 포함합니다.
{% endcolumn %}

{% column %}
**작업에서 브랜치명 복사**

작업의 우측 사이드바의 상단에 있는 \[브랜치명 복사하기] 버튼을 통해 키 번호가 포함된 브랜치명을 쉽게 생성하고 복사할 수 있습니다. 복사된 브랜치명으로 Github에서 새 브랜치를 생성하면 됩니다.

<figure><img src="/files/jntwFlu9mTaTpIDMQ0gB" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

#### 2. 작업에서 PR 실시간 확인

작업 상세 페이지에서는 연결된 모든 Pull Request(PR)를 확인할 수 있습니다. 각각의 PR은 현재 상태(Merged, Open, Closed 등)와 최종 업데이트일 담당자를 확인할 수 있습니다.

깃허브를 방문하지 않고도 개발 진행 상황을 한눈에 확인할 수 있으며, PR을 클릭하면 Github의 해당 PR 페이지로 바로 이동하여 상세한 논의 내용을 확인할 수 있습니다.

<figure><img src="/files/3rJeuV5vcBeWDrDYrI1K" alt=""><figcaption></figcaption></figure>

## 작업 상태 자동화

연결된 브랜치에 업데이트가 생길 경우, 뤼이도 작업 상태를 자동으로 업데이트하여 수동 작업을 완전히 제거합니다.

#### 1. 기본 자동화 설정

최초 연동시, 팀의 작업 흐름에 맞게 다음과 같은 자동화가 기본적으로 설정되어 있습니다. PR이 Merge될 경우, 뤼이도의 작업 상태가 자동으로 완료로 변경됩니다.

| Github Action | 뤼이도 상태 |
| ------------- | ------ |
| Merge         | 완료     |

#### 2. 자동화 커스텀

상태 자동화는 팀의 특성에 맞게 세부적으로 커스텀 할 수 있습니다. \[설정 > 워크스페이스 > 외부 연동 > Github] 페이지에서 커스텀이 가능합니다. 상태 자동화는 팀과 관련된 설정이기 때문에, 워크스페이스에 존재하는 각 팀별로 설정 업데이트가 필요합니다.

자동화를 적용할 수 있는 깃허브 액션은 `Branch Create`, `PR Open`, `PR Close`, `Merge`로 총 4가지가 존재합니다.

{% hint style="info" %}
팀별 상태는 팀별 \[설장 > 팀 > 작업 상태] 페이지에서 커스텀 가능하며, 뤼이도의 작업 상태에 대한 상세한 설명은 [작업 상태](https://docs.riido.io/teams/statuses)에서 확인할 수 있습니다.
{% endhint %}

<figure><img src="/files/nXiyYEQpSwk2YKMLO0Ag" alt=""><figcaption></figcaption></figure>