GitHub Autolink 를 알아보자

 

 

개요

막연히 연동을 눈치채고 있었는데 이참에 GitHub 의 외부 링크 연동기능을 알아본다.

GitHub 문서 링크: https://bit.ly/4470tGd

참고 블로그 링크: https://devs0n.tistory.com/139?utm_source=oneoneone

쉽게 말해서

GitHub의 autolink 기능은 특정 키워드를 자동으로 외부 링크로 변환해준다. 사용자는 리포지토리 설정에서 키워드와 매칭되는 URL 패턴을 설정할 수 있으며, 이 때 :id 와일드카드를 활용해 동적인 URL을 생성한다. 이 기능을 통해 커밋 메시지, 풀 리퀘스트, 이슈 등에서 외부 자원을 쉽게 참조하고 접근할 수 있습니다.

From GitHub(커밋 메시지, 풀 리퀘스트, 이슈) → To Resource

공짜는 아니다

유료 구독 플랜에서만 가능하다.

GitHub Pro, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server

설정방법

설정을 위해서는 관리자 권한이 필요하다.

1. 리포지토리로 가서 Settings → Autolink reference 선택
2. Add autolink reference 버튼을 눌러 새로이 생성 시작
   1. 동적으로 들어갈 값의 형태 선택
      1. Alphanumeric은 알파벳, 숫자, - 가 가능하다. 대소문자는 상관없다.
      2. Numeric은 숫자만 가능
   2. Prefix 정의: 앞에 붙는 값을 정해준다.
   3. Target URL: 실제 연결될 URL 값을 정해준다. 맨 끝에 동적으로 적용될 부분은 <num> 이라고 지정해준다.

설정예시

회사의 지라 티켓의 링크가 다음과 같다고 해보자

https://mycompany.atlassian.net/browse/BACKEND-641

1. 값의 형태: 641 이라는 값을 인식해야 한다. 동적으로 들어갈 값은 Alphanumeric, Numeric 모두 가능할 것이다.
2. Prefix: BACKEND- 가 될 것이다.
3. Target URL: https://mycompany.atlassian.net/browse/=<num> 이 될 것이다.

이제

• BACKEND-641 이라고 쓰면
• https://mycompany.atlassian.net/browse/BACKEND-641 링크가 걸리게 된다.