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

github action으로 배포 시 api doc 갱신안됨 #134

Open
seungyeonchoi opened this issue Jun 17, 2023 · 2 comments
Open

github action으로 배포 시 api doc 갱신안됨 #134

seungyeonchoi opened this issue Jun 17, 2023 · 2 comments

Comments

@seungyeonchoi
Copy link
Contributor

#133 반영했는데, api document에서는 새로운 수정사항 반영안됨.
빌드과정에서 test code 돌리고 -> document 업데이트하는 과정을 추가해야할 것 같은데, 확인 필요

@cnpcnp99
Copy link
Contributor

일단 수동 작업이지만 다음 방식이 가능할 거 같습니다.

  1. PR 올리기 전 resources/static 하위에 있는 api-doc.html 파일을 지우고 build작업을 해 새로운 api-doc.html을 생성하고 해당 사항까지 반영해 PR을 올린다.
  2. PR 올리기 전 그냥 ap-doc.html파일을 지우기만 하고 PR을 올린다.

1번 방법은 아마 확실히 수정 사항이 반영될 텐데 2번은 어떨지 테스트해보진 않아 확실치는 않지만 자동 빌드하면서 api-doc.html 파일이 생성되지 않을까 싶네요. 사실 수동으로 배포할 때도 위 이슈는 있었던 거 같습니다.
여태까지 수동 배포하면서 api-doc.html파일을 지우고 build를 실행해 새로운 api-doc.html파일을 생성하는 방식으로 배포해오고 있었습니다.

@seungyeonchoi
Copy link
Contributor Author

아!! 그러면 2번이 조금 더 간편하니까 테스트해보고 코멘트 추가해두겠습니다!! 조언감사드립니다 +_+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants