시크릿 스캐닝(Secret Scanning) 기능 개선으로 개발자 생산성 향상
API 필터(API Filter), 웹훅 페이로드(Webhook Payload), 위임된 알림 워크플로우(Delegated Alert Workflow) 개선을 통해 개발자 경험(Developer Experience) 향상을 목표로 함
`exclude_secret_types` 필터를 추가하여 특정 시크릿 유형(Secret Type) 제외 기능을 제공하고, API 및 웹훅(Webhook)에 HTML URL(HTML URL) 필드를 추가
위임된 우회 요청(Delegated Bypass Request) 이메일에 만료 기한을 추가하고, 개발자에게 알림 해제 요청(Alert Dismissal Request) 확인 이메일을 발송
알림 페이로드(Alert Payload)에 요청자 및 검토자 코멘트(Requester & Reviewer Comments)를 포함하여 위임된 알림 해제(Delegated Closure) 관련 정보 제공
exclude_secret_types 필터(Filter)의 활용
본문에 따르면, `exclude_secret_types` 필터를 통해 특정 시크릿 유형(Secret Type)을 제외함으로써, 보고 및 수정 스크립트에서 수동적인 유형 추가 작업을 자동화할 수 있다.
기존 방식: 포함 기반 필터링(Inclusion-based Filtering)은 새로운 시크릿 유형 추가 시마다 수동 업데이트 필요
개선 사항: 제외 기반 필터링(Exclusion-based Filtering)으로 불필요한 유형을 제외하고, 새로운 유형 자동 포함
API 엔드포인트(API Endpoint): `/repos/{owner}/{repo}/secret-scanning/alerts`, `/orgs/{org}/secret-scanning/alerts`, `/enterprises/{enterprise}/secret-scanning/alerts`에서 사용 가능
결과적으로, 이 기능은 시크릿 스캐닝(Secret Scanning) 관리 효율성을 높이고, 개발자가 새로운 시크릿 유형에 대응하는 부담을 줄여준다.
HTML URL(HTML URL) 필드 추가의 의미
글에 따르면, REST API 및 웹훅(Webhook) 페이로드(Payload)에 `html_url` 필드를 추가하여, 알림 위치에 대한 직접적인 링크(Direct Link) 제공한다.
기존 문제점: API URL만 제공되어, 추가 API 호출을 통해 링크를 얻어야 하는 불편함
개선 효과: 클릭 가능한 URL(Clickable URL) 제공으로 알림 처리 자동화 및 사용자 경험(User Experience) 향상
지원 대상: 커밋(Commit), 이슈(Issue), 풀 리퀘스트(Pull Request), 리뷰(Review) 등 다양한 위치
이러한 개선은 개발자가 알림을 확인하고 대응하는 과정(Alert Handling Process)을 간소화하여, 생산성을 높이는 데 기여한다.
위임된 우회 요청(Delegated Bypass Request) 이메일 개선
본문에서는 위임된 우회 요청(Delegated Bypass Request) 이메일에 만료 기한(Expiry Deadline) 정보를 추가하여, 검토자가 기한 내에 조치하도록 유도한다.
만료 기한 정보: 요청 유형에 따라 7일, 30일, 1년 등 다양한 만료 기간(Expiration Period) 명시
개발자 확인 이메일: 알림 해제 요청 시 개발자에게 확인 이메일(Confirmation Email) 발송
기존 문제점: 검토자에게만 알림이 가고, 요청자는 진행 상황을 알 수 없었음
이러한 개선은 알림 처리 과정의 투명성(Transparency)을 높이고, 개발자와 검토자 간의 원활한 소통(Smooth Communication)을 지원한다.
알림 페이로드(Alert Payload)에 코멘트(Comment) 추가
글에 따르면, 위임된 알림 해제(Delegated Closure) 요청 시, 요청자 및 검토자의 코멘트(Comments)를 API 및 웹훅(Webhook) 페이로드(Payload)에 포함한다.
추가 정보: `closure_request_comment`, `closure_request_reviewer_comment`, `closure_request_reviewer` 필드 추가
활용 방안: 알림 해제 사유 추적, 검토 결정 감사, 외부 티켓 시스템(Ticketing System) 연동
기존 문제점: 알림 해제 관련 정보가 부족하여, 감사 및 분석(Auditing & Analysis) 어려움 발생
이러한 개선은 알림 해제 과정에 대한 가시성(Visibility)을 확보하고, 보안 관리 및 규정 준수(Compliance)를 강화하는 데 기여한다.
해결 코멘트(Resolution Comment) 버그 수정
본문에 따르면, 위임된 알림 해제 승인(Delegated Alert Closure Approval) 시, `resolution_comment` 필드가 null로 설정되는 버그를 수정했다.
버그 내용: 요청자의 코멘트가 알림에 전달되지 않음
수정 사항: 요청자의 코멘트가 알림의 `resolution_comment` 필드에 정상적으로 전달되도록 수정
영향: 알림 해제 사유(Alert Closure Reason) 기록의 정확성(Accuracy) 향상
이러한 수정은 알림 관리 시스템(Alert Management System)의 신뢰성(Reliability)을 높이고, 문제 해결 과정에 대한 정확한 정보(Accurate Information) 제공을 가능하게 한다.
