[Github] 텍스트를 링크로 변경하기 - Autolink references

Github에는 특정 텍스트에 대해 자동으로 링크를 연결해주는 Autolink references라는 기능이 있다.

기본적으로 commit hash나 #{PR number} 를 입력하면 자동으로 링크로 변경해준다.

 

하지만 기본적으로 제공되는 것 외에도 custom으로 추가할 수 있다.

(나의 경우 주로 Jira 티켓 번호를 해당 티켓의 URL과 연결하는 용도로 사용한다)

 

그 방법은 아래와 같다.

 

1. Github repository의 Settings > Autolink references에 들어간다.

2. 생성하고자하는 autolink reference에 대한 규칙을 지정한다.

예시로 구글 검색을 할 수 있는 기능을 추가해보겠다.

Target URL을 보면 확인할 수 있듯이 입력되는 텍스트는 <num> 이라는 변수로 사용된다.

 

설정을 완료하였으면 Add autolink reference 버튼을 눌러 설정을 저장하면 된다.

 

3. PR 설명이나 코멘트에 앞서 생성한 규칙에 맞게 텍스트를 입력하면 아래와 같이 텍스트가 링크로 변환되는 것을 확인할 수 있다.

 

텍스트 링크를 클릭하였을 때

 

 

참고: Github document - Configuring autolinks to reference external resources