Skip to content

Conversation

HC-kang
Copy link
Contributor

@HC-kang HC-kang commented Nov 29, 2024

목적

  • 멤버분들께서 답안을 제출하실 때, 파일명을 "계정명.확장자" 형태로 강제하기 위한 CI 스텝을 추가합니다.

동작 예시

올바른 파일명 사용시(HC-kang.js)

image

올바르지 않은 파일명 사용시(hckang.js)

image

예외사항

종종 아래와 같은 경우가 발생할 수 있습니다.

  1. 답안 제출목적이 아닌, 워크플로우 수정이나 스크립트 추가 등의 작업이 필요한 경우
  2. 필요에 따라 다른 사람의 답안을 수정해야 하는 경우

예시

image

이러한 경우 maintenance 라벨을 사용하시면 해당 파일명 검증 스텝을 우회 할수 있습니다.

image

기타

  • 안내문구 자체는 파일명이 계정명과 일치하는 형태로 표현되고있으나, 사실 Prefix로 동작합니다.
  • 대소문자는 구별하지 않습니다. (hc-kang, Hc-KaNg... 등 모두 허용)

@HC-kang HC-kang requested a review from a team as a code owner November 29, 2024 14:45
@DaleSeo
Copy link
Member

DaleSeo commented Nov 29, 2024

안내문구 자체는 파일명이 계정명과 일치하는 형태로 표현되고있으나, 사실 Prefix로 동작합니다.

혼선의 여지가 없도록 안내문구에도 좀 더 정확히 표현해주면 어떨까요?

3. 파일명은 반드시 'GitHub계정명' 또는 'GitHub계정명-xxx' 형식으로 해주셔야 합니다. (예: ${pr_author}.ts, ${pr_author}-1.ts, ${pr_author}-2.ts)

env:
GH_TOKEN: ${{ github.token }}

- name: Check for 1. missing end line breaks and 2. control characters in filenames and 3. filename rules
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 스탭이 너무 길어진 것 같은데 혹시 3개로 나누어주실 수 있으실까요? 그럼, 답안 제출자가 어떤 단계에서 실패했는지 좀 더 쉽게 파악할 수 있을 것 같아요.

Comment on lines 87 to 88
# maintenance 라벨이 없는 경우에만 파일명 규칙 체크
if [ "$has_maintenance" != "true" ]; then
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

라벨을 활용하는 아이디어 좋네요! 💡

@HC-kang
Copy link
Contributor Author

HC-kang commented Nov 30, 2024

@DaleSeo 님께서 의견 주신내용 반영하여 PR 수정하였습니다!

  • 파일명에 대한 안내 메시지 수정(Prefix.)
image
  • 검증 스텝 3분할

  • 라인브레이크 누락

    • image
  • 파일명에 제어문자 포함

    • image
  • 파일명과 사용자명 비교검증

    • image

Copy link
Member

@DaleSeo DaleSeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

캬~ 깔끔합니다! 💯

@HC-kang HC-kang merged commit d64c4ae into DaleStudy:main Nov 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants