내 워크플로우

인기 있는 프로젝트의 기여 지침에는 종종 facebook/docusaurus의 다음과 같은 권장 제목 스타일이 포함됩니다.

feat: allow overriding of webpack config
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

PR Title Checker은 이러한 지침을 준수하지 않는 제목에 태그를 지정하여 관리자가 프로젝트를 더 잘 구성할 수 있도록 도와줍니다. 아니요, 요약이 현재 시제인지 확인하지 않습니다 😅. 적어도 아직은!

풀 리퀘스트 제목은 특정 접두사(또는 정규식 또는 둘 다!)를 확인하고 준수하지 않을 경우 자동으로 태그를 지정할 수 있습니다. 이것은 일반적으로 관리자가 고군분투한 밤의 잠에서 깨어날 때 기여 지침에 모든 것이 완벽하게 배치된 후에도 이상한 이름의 끌어오기 요청에 직면할 필요가 없도록 작성자 스스로 수정하라는 메시지를 표시합니다. . 아 그리고 btw, 이 작은 Github 작업은 작성자가 기여 지침을 정말로 읽었는지도 보여줄 수 있습니다 ;)

제출 카테고리:

메인테이너 머스트 해브(또는 메인테이너를 위한 별난 와일드카드? 🤔)

Yaml 파일 또는 코드 링크

테하니모 / pr-제목-검사기

풀 요청 제목이 기여 지침을 준수하는지 자동으로 확인하는 작업

풀 리퀘스트 제목 검사기

이 작업은 PR 제목이 기여 지침을 준수하는지 확인합니다. ☑️
일관된 제목 이름은 메인테이너가 프로젝트를 더 잘 구성하는 데 도움이 됩니다 📚
작성자가 기여 가이드라인을 제대로 읽었는지 보여줍니다 😉

용법

아래와 같이 .github/pr-title-styles.json를 만듭니다.

{
  "LABEL": {
    "name": "title needs formatting"
    "color": "EEEEEE"
  }
  "CHECKS": {
    "prefixes": ["fix: ", "feat: "]
    "regexp": "docs\\(v[0-9]\\): "
  }
}

If none of the checks pass, a label will be added to that pull request.
If at least one of them passes, the label will be removed.

워크플로 만들기

Create a workflow (eg: .github/workflows/pr-title-cheker.yml see Creating a Workflow file) to utilize the pr-title-checker action with content:

name: "PR Title

…

View on GitHub

추가 리소스/정보

이것은 Github 액션(및 DEV 게시물!)을 구축하는 첫 번째 기회였습니다. 출시된지 얼마 안되서 아직 사용하는 프로젝트가 많지 않아요! (변경하는 데 도움을 줄 수 있습니다here 🙂)

아래에서 여러분의 생각을 듣고 싶습니다! 💭