Skip to content

Commit

Permalink
docs: Contributing 문서 보완 (tag-and-publish)
Browse files Browse the repository at this point in the history
  • Loading branch information
roeniss committed Feb 23, 2024
1 parent 2575b90 commit 28312d6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ mailjet_sender_email = "YOUR_MAILJET_EMAIL"
>
> 따로 세팅을 하지 않은 상태로 별도의 이메일을 기입하게 되면, 실제 메일이 발송되지 않고 'Senders and domains page'를 확인하라는 안내 메일을 받게 됩니다.
## 기여하기

기여는 대환영입니다! [CONTRIBUTING.md](/docs/CONTRIBUTING.md) 파일을 참고해주세요.

## 기부하기

이 프로그램을 사용해서 1등에 당첨된다면, 저에게 꼭 1000만원을 기부해주시길 바랍니다.
Expand All @@ -91,3 +87,7 @@ mailjet_sender_email = "YOUR_MAILJET_EMAIL"
그리고 딱히 당첨된 적은 없지만 그래도 커피를 사주고 싶다면, 절대 망설이지 마십시오.

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/roeniss)

## 기여하기

기여는 대환영입니다! [CONTRIBUTING.md](/docs/CONTRIBUTING.md) 파일을 참고해주세요.
11 changes: 2 additions & 9 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@

동행복권 사이트는 `JSESSIONID`를 이용하여 유저를 인증합니다. 본 API에서는 `requests`를 이용해 로그인한 후 `JSESSIONID`를 메모리에 저장해 복권 구매에 활용합니다.

### 모듈 구조

main.py -> router -> 요청에 따른 특정 controller -> client (동행복권 사이트 호출)

router, client, controller 가 모두 domain_object 에 의존하는 형태입니다.

### 트러블슈팅 가이드

#### main.py 가 실행이 안될 때
Expand All @@ -36,9 +30,8 @@ make lintfmt
이 작업은 메인테이너가 진행합니다.

1. main 브랜치에서 [VERSION](./VERSION) 을 수정한 후 master 브랜치로 PR 생성합니다.
2. CI가 통과되고 머지되면 배포를 위한 GitHub Actions 워크플로우가 진행됩니다. 이 과정에서 git tag가 생성됩니다.
3. tag 생성이 진행되면 바로 Pypi 에 새 버전 배포가 진행됩니다. 여기까지가 GitHub Actions 워크플로우 과정입니다.
4. 생성된 tag로 GitHub Release를 생성합니다.
2. CI가 통과되고 머지되면 [tag-and-publish 워크플로우](https://github.com/roeniss/dhlottery-api/actions/workflows/tag-and-publish.yml) 를 직접 수행합니다. 이렇게 하면 tag 생성이 진행되고 바로 이어서 Pypi 에 새 버전 배포가 진행됩니다.
3. 생성된 tag로 GitHub Release 를 생성합니다.

### 참고자료

Expand Down

0 comments on commit 28312d6

Please sign in to comment.