Jira 개발 환경 설정
앱을 설치하고 테스트하려면 다음이 필요합니다.
- Jira Cloud 인스턴스. Atlassian은 개발 및 테스트용 무료 인스턴스를 제공합니다.
-
인터넷을 통해 액세스할 수 있는 GitLab 인스턴스. Jira Cloud가 인터넷을 통해 GitLab 인스턴스에 연결할 수 있어야 합니다. 이를 위해 Gitpod나 유사한 클라우드 개발 환경을 사용하는 것이 좋습니다. Gitpod를 GDK와 함께 사용하는 방법에 대한 자세한 정보는 다음을 참조하세요.
- Gitpod에서 GDK 실행하기 비디오.
- Gitpod에서 GDK 사용하기 문서.
Serveo나
ngrok
와 같은 터널링 도구를 사용해서는 절대로 안 됩니다. 이러한 도구는 보안 위험이며 개발자 노트북에서 실행해서는 안 됩니다.Jira는 앱 호스트로의 모든 연결을 SSL을 통해해야 합니다. 자체 환경을 설정하는 경우 SSL을 활성화하고 적절한 인증서를 사용해야 합니다.
Jira에 앱 설치하기
Jira에 앱을 설치하려면:
-
Atlassian Marketplace에서 오지 않은 앱을 설치하려면 Jira 개발 모드를 활성화하세요.
- Jira에서 Jira 설정 > 앱 > 앱 관리로 이동합니다.
- 앱 관리 페이지의 맨 아래로 스크롤하여 설정을 선택합니다.
- 개발 모드 활성화를 선택하고 적용을 선택합니다.
-
앱을 설치합니다.
- Jira에서 Jira 설정 > 앱 > 앱 관리로 이동합니다.
- 앱 업로드를 선택합니다.
-
이 URL에서 필드에 앱 기술자에 대한 링크를 제공합니다. 호스트 및 포트는 GitLab 인스턴스를 가리켜야 합니다.
예:
https://xxxx.gitpod.io/-/jira_connect/app_descriptor.json
- 업로드를 선택합니다.
설치가 성공하면 앱 관리 아래에서 Jira Cloud용 GitLab 앱이 표시됩니다. 또한 시작하기를 선택하여 GitLab 인스턴스에서 렌더링된 구성 페이지를 열 수 있습니다.
앱 기술자에 대한 모든 변경 사항은 앱을 제거한 후 다시 설치해야 합니다.
간단한 설정
Gitpod 및 Jira Cloud 인스턴스와 같은 외부 의존성을 피하려면 Jira 연결 테스트 도구 및 로컬 GDK를 사용하세요.
-
Jira-connect-test-tool을 복제하세요.
git clone git@gitlab.com:gitlab-org/manage/integrations/jira-connect-test-tool.git
. - 앱을 시작합니다.
bundle exec rackup
. (앱은 GDK GitLab이http://127.0.0.1:3000
에서 사용 가능해야 합니다.). -
config/gitlab.yml
을 열고jira_connect
구성의 주석을 제거하세요. -
additional_iframe_ancestors
에localhost
와 같은 도메인을 추가해야 하는 경우 GDK를 실행하는 도메인을 추가해야 합니다. 예:additional_iframe_ancestors: ['localhost:*', '127.0.0.1:*', 'gdk.test:*']
- GDK를 다시 시작합니다.
-
http://127.0.0.1:3000/-/user_settings/personal_access_tokens
로 이동합니다. -
api
스코프로 새 토큰을 생성하고 토큰을 복사합니다. -
http://localhost:9292
로 이동합니다. - 토큰을 붙여넣고 GitLab.com Jira Cloud 앱 설치를 선택합니다.
GitLab OAuth 인증 흐름 테스트
- GitLab 16.0부터 일반적으로 사용 가능. 피처 플래그
jira_connect_oauth
가 제거되었습니다.
GitLab for Jira 사용자는 GitLab OAuth를 사용하여 GitLab에 인증할 수 있습니다.
다음 단계는 GitLab OAuth 흐름을 테스트하기 위한 환경 설정을 설명합니다:
- Gitpod 세션을 시작합니다.
- GitLab 인스턴스에서 관리 > 애플리케이션으로 이동합니다.
- 다음 설정으로 새 애플리케이션을 만듭니다:
- 이름:
GitLab for Jira
- 리디렉션 URI:
YOUR_GITPOD_INSTANCE/-/jira_connect/oauth_callbacks
- 신뢰됨: 아니요
- 기밀: 아니요
- 스코프:
api
- 이름:
- 애플리케이션 ID 값을 복사합니다.
- 관리 > 설정 > 일반으로 이동합니다.
- GitLab for Jira App을 확장합니다.
- 애플리케이션 ID 값을 Jira Connect 애플리케이션 ID에 붙여넣습니다.
-
Jira Connect Proxy URL에
YOUR_GITPOD_INSTANCE
(예:https://xxxx.gitpod.io
)를 입력합니다. - 공개 키 저장 활성화를 선택합니다.
- 변경 사항 저장을 선택합니다.
문제 해결
앱 설치 실패
앱 설치가 실패하는 경우 데이터베이스에서 jira_connect_installations
을 삭제해야 할 수 있습니다.
- 데이터베이스 콘솔을 엽니다.
-
TRUNCATE TABLE jira_connect_installations CASCADE;
를 실행합니다.
파일에 액세스할 수 없음
Gitpod을 사용하고 Jira가 설명자 파일에 액세스할 수 없다는 오류가 발생하는 경우 GDK 포트를 공개로 설정해야 할 수 있습니다. 다음 단계를 따라야 합니다.
- Gitpod에서 GitLab 작업 영역을 엽니다.
- GDK가 실행 중인 경우 오른쪽 하단의 포트를 선택합니다.
- 왼쪽 사이드바에서 GDK가 수신 대기 중인 포트(일반적으로
3000
)를 선택합니다. - 포트가 비공개로 표시되면 잠금 아이콘을 선택하여 공개로 설정합니다.