코드 품질

CI/CD 파이프라인에 코드 품질 스캐닝 도구와 린터를 통합하는 방법을 설명합니다.

코드 품질은 유지보수성 문제가 기술 부채가 되기 전에 이를 식별합니다. 코드 리뷰 중에 이루어지는 자동화된 피드백은 팀이 더 나은 코드를 작성하는 데 도움이 됩니다. 발견된 문제는 머지 리퀘스트에 직접 표시되므로, 수정 비용이 가장 낮은 시점에 문제를 확인할 수 있습니다. 코드 품질은 다양한 프로그래밍 언어에서 동작하며, 일반적으로 쓰이는 린터, 스타일 검사기, 복잡도 분석기와 통합됩니다. 기존에 사용하던 도구를 코드 품질 워크플로에 연동할 수 있으므로, 팀이 선호하는 도구는 그대로 유지하면서 결과 표시 방식만 표준화할 수 있습니다. Features per tier # 다음 표와 같이 GitLab 티어 에 따라 사용할 수 있는 기능이 다릅니다. 기능 Free 포함 Premium 포함 Ultimate 포함 CI/CD job에서 코드 품질 결과 가져오기 ✅ ✅ ✅ CodeClimate 기반 스캐닝 사용 ✅ ✅ ✅ 머지 리퀘스트 보고서에서 결과 확인 ✅ ✅ ✅ 파이프라인 보고서에서 결과 확인 ❌ ✅ ✅ 머지 리퀘스트 변경 사항 보기에서 결과 확인 ❌ ❌ ✅ 프로젝트 품질 요약 보기에서 전체 상태 분석 ❌ ❌ ✅ Scan code for quality violations # 코드 품질은 다양한 스캐닝 도구의 결과를 가져오도록 지원하는 개방형 시스템입니다. 위반 사항을 찾아 표시하려면 다음 방법을 사용할 수 있습니다. 스캐닝 도구를 직접 사용하고 그 결과를 가져옵니다 . (권장) 내장된 CI/CD 템플릿을 사용 하여 스캐닝을 활성화합니다. 이 템플릿은 일반적인 오픈 소스 도구를 감싸는 CodeClimate 엔진을 사용합니다. (지원 중단) 하나의 파이프라인에서 여러 도구의 결과를 함께 수집할 수 있습니다. 예를 들어 코드를 스캔하는 코드 린터와 문서를 스캔하는 언어 린터를 함께 실행하거나, 독립형 도구를 CodeClimate 기반 스캐닝과 함께 사용할 수 있습니다. 코드 품질은 모든 보고서를 통합하므로 결과를 볼 때 전체 내용을 한 번에 확인할 수 있습니다. Import Code Quality results from a CI/CD job # 많은 개발 팀이 이미 CI/CD 파이프라인에서 린터, 스타일 검사기, 그 밖의 도구를 사용해 코딩 표준 위반 사항을 자동으로 감지하고 있습니다. 이러한 도구가 찾아낸 문제를 코드 품질과 통합하면 더 쉽게 확인하고 수정할 수 있습니다. 사용 중인 도구에 이미 문서화된 통합 방법이 있는지 확인하려면 코드 품질과 일반적인 도구 통합하기 를 참고합니다. 다른 도구를 코드 품질과 통합하려면 다음과 같이 진행합니다. CI/CD 파이프라인에 도구를 추가합니다. 도구가 보고서를 파일로 출력하도록 설정합니다. 이 파일은 특정 JSON 형식 을 사용해야 합니다. 많은 도구가 이 출력 형식을 기본으로 지원합니다. 이를 "CodeClimate report", "GitLab Code Quality report" 또는 이와 비슷한 이름으로 부르기도 합니다. 다른 도구는 사용자 정의 JSON 형식이나 템플릿을 사용해 JSON 출력을 만