이 문서는 Sonarqube Portfolio 가이드를 공유하기 위해 작성되었다.
| 도구명 | Sonarqube |
|---|---|
| 버전 | 9.5 |
| OS | CentOS 8 |
| 비고 | Enterprise 이상 가능 |
해당 기능은 Enterprise Edition부터 가능하다.
Sonarqube Portfolio란
해당 포트폴리오에 있는 모든 프로젝트의 릴리스 가능성에 대한 종합적인 뷰를 제공한다.(안정성, 보안 취약성, 유지 관리 등급)
Portfolio 생성
Portfolio 생성 권한 확인
Administration → Security → Global Permissions 선택
- Create에서 Portfolios 가 있어야만 Portfolio를 생성 할 수 있다.
Portfolio 생성하기
상단 메뉴 Portfolios 선택 → Create Portfolios 선택
Create Portfolio 아래 정보를 입력하고 Create 버튼을 클릭한다.
- Name
- Description
- Key: 따로 입력 없을 경우 Name에서 자동으로 가져온다
- Visibility
Portfolio 권한
Portfolio Settings → Permissions: 해당 Portfolio의 권한을 설정 할 수 있다.
- Private인 경우 Browse 권한이 없을 경우 Issue를 수정,변경 할 수 없다.
- Administer를 줄 경우 Browse 권한도 필요하다.
Portfolio에 Project 추가하기
Portfolio Project 설정 들어가기
Portfolio Settings → Edit Definition → Project selection mode 의 연필 클릭
Project를 추가하는 방법에는 4가지 방법이 있다.
- Manual: 수동으로 선택하여 추가한다.
- By tags: 해당 tag가 있는 Project가 자동으로 포함된다.
- By regular expression: 해당 정규표현식에 일치하는 Project가 자동으로 포함된다.
- All Projects: 모든 프로젝트
Portfolio Project Branch 선택(Sonarqube 9.2이상)
Sonarqube 9.2 이상부터 Project의 Branch를 선택 할 수 있다.(기존 matser)
Portfolio Settings → Edit Definition → 선택된 Project 옆의 연필 클릭
반영하기
Portfolio Settings → Edit Definition → Recompute 를 선택하면 즉각적으로 반영된다.
해당 Job은 Portfolio Settings → Backgroud Tasks에 확인 할 수 있다.
Portfolio에 Application 혹은 다른 Portfolio 추가하기
Application이란
- 여러 개의 프로젝트를 하나의 큰 프로젝트로 집계
- Portfolio와의 차이점: Portfolio는 여러 개의 큰 프로젝트. Application은 하나의 큰 프로젝트
Application 생성하기
Administration → Confugration → Portfolios 선택
Create → Application 선택 후 해당 값들 설정
- Name
- Description
- Key: 따로 입력 없을 경우 Name에서 자동으로 가져온다
- Visibility
Portfolio에 추가하기
Portfolio Settings → Edit Definition 선택
Add Portfolio → Local Reference → 원하는 Application이나 Portfolio 선택
Portfolio PDF
Portfolio 생성 시 해당 Portfolio를 PDF로 다운로드 하거나 특정 주기마다 이메일로 보내는 기능이 있다.
PDF Download
해당 Portfolio 선택 → Portfolio PDF Report 선택 시 다운로드 하거나 이메일로 보낼 수 있다.(이메일 설정 시)
PDF 주기 설정
전체 Portfolio 설정
Administration → Confugration → Governance 선택
- Frequency: 월, 일, 주로 선택 가능
- Reciptions: PDF를 받는 이메일 설정
- Portfolio Calculation Hours: Portfolio를 Recompute 하는 시간 설정
개별 Portfolio 설정
해당 Portfolio 선택 → Portfolio Settings → Executive Report 선택
- Frequency: 월, 일, 주로 선택 가능
- Other Reciptions: 전역 설정말고 다른 이메일 가능
참조 링크
Sonarqube