Skip to content

fix: PR 본문이 템플릿을 따르지 않으면 머지 뒤에야 배포가 깨진다 #182

Closed

Description

@OnlyReadOneBook

무엇이 문제인가

테스터 배포 노트는 머지된 PR 본문의 「📌 Issues」·「📎 Work Description」 섹션에서 만든다. 두 섹션 중 하나라도 비어 있으면 배포가 실패한다 — 테스터가 무엇을 확인할지 모르는 배포는 내보내지 않겠다는 결정이고, 그 자체는 옳다.

문제는 언제 걸리느냐다. 이 검사는 main push 에서만 돈다. PR 검사(repository-quality)는 이슈 연결만 보고 섹션은 보지 않는다. 그래서 자유 형식으로 쓴 PR 은 전부 초록으로 통과하고, 머지된 뒤에 배포가 빨개진다. 되돌릴 수도 없다 — 이미 main 이다.

실제로 오늘 그렇게 됐다. #175 는 모든 검사를 통과하고 머지됐고, 그 커밋의 테스터 배포는 「Issues 섹션에는 #123 형식의 이슈 번호가 하나 이상 필요합니다」 로 실패했다. 그 판의 앱은 테스터에게 나가지 않았다.

함께 있는 문제: 노트에 마크다운이 그대로 들어간다

Work Description 의 모든 줄이 그대로 항목이 된다. 표를 쓰면 | 경로 | 담는 값 | 이 항목으로 들어가고, 코드 블록을 쓰면 백틱 세 개짜리 줄이 항목이 된다. 링크·굵게·인라인 코드 표기도 원문 그대로 나간다.

테스터가 받는 것은 앱 안의 짧은 목록이다. 거기에 표 구분선과 백틱이 섞이면 무엇이 바뀌었는지 읽기 어렵다.

어떻게 고치는가

  1. PR 검사에서 배포와 같은 코드로 노트를 만들어 본다. 실패하면 PR 이 빨개진다. 검사를 새로 쓰지 않고 같은 스크립트를 그대로 부른다 — 따로 쓰면 둘이 어긋난다.
  2. 노트를 만들 때 마크다운 장식을 걷어 낸다.
    • 코드 블록(```· ~~~)은 통째로 뺀다
    • 표의 줄과 구분선, 인용(>), 수평선, 이미지, HTML 태그 줄을 뺀다
    • 굵게·기울임·인라인 코드 표기를 벗기고, 링크는 글자만 남긴다

확인

  • 섹션이 비거나 없는 본문으로 PR 검사가 실패한다
  • 코드 블록·표·링크가 섞인 본문에서 사람이 읽을 문장만 남는다

Metadata

Metadata

Labels

Bug버그 수정 (fix)

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions