Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] 풀이법 설명 문서 자동생성 CI #6

Open
1 of 8 tasks
Cotidie opened this issue Oct 28, 2023 · 0 comments
Open
1 of 8 tasks

[Suggestion] 풀이법 설명 문서 자동생성 CI #6

Cotidie opened this issue Oct 28, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Cotidie
Copy link
Contributor

Cotidie commented Oct 28, 2023

문제

  • Github에 풀이법 .md 파일을 올리기는 번거롭습니다.
  • 나중에 문제를 리뷰하려면 노션과 Github 모두 들러야 합니다.

제안

  • PR에 풀이 문제에 대한 설명을 담는다. (노션 복붙)
  • PR이 병합되면 Github Action을 트리거한다.
  • Github Action은 PR의 내용을 가져와 동일한 파일명의 .md를 생성한다.
  • 전체 코드는 Github에만 올리고, Notion에는 코드에 대한 링크만 담는다.

할일

  • PR 템플릿 작성
  • Github Action 학습
  • Action1: PR이 생성되거나 갱신될 때 PR에 포함된 파일은 1개 뿐이도록 검사
  • Action1 개선: 그 하나의 파일이 소스코드임을 보장
  • Action2: PR의 병합될 때 PR의 내용을 따 파일명.md를 같은 폴더에 생성
  • Action2 개선: 빈 PR 문서는 생성하지 않음
  • Action1 & 2 개선: PR에 파일 여러 개 가능
  • Action1 & 2 개선: 소스코드가 아니라면 동작하지 않음

예상 이슈

  • 그냥 md 파일 만들어서 PR 올리면 되는데...?
  • 이미지도 복붙이 될까...?
  • 풀이 코드 파일 이외에 같이 올리는 파일이 있을까?
  • main에 바로 올리는 편이 더 편할 수 있다.

비고

CI는 개발자가 개발에만 집중할 수 있도록 도와줍니다. 이번 건 아닐 수도 있지만...
이번 기회에 Github Action을 통해 CI를 연습해보는 건 어떨까요?

@Cotidie Cotidie added the enhancement New feature or request label Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants