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.

Sign up for GitHub

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

Add 'Update Swagger doc' workflow #894

Merged
merged 2 commits into from
Oct 30, 2021
Merged

Add 'Update Swagger doc' workflow #894

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab37e04
Update 'make swagger' workflow(#804)
computerphilosopher Oct 26, 2021
c330529
Disable swagger workflow in forked repository
computerphilosopher Oct 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/make-swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Apply make swagger
on:
push:
branches:
- main
paths:
- 'src/core/**/**.go'
- 'src/api/rest/server/**/**.go'
jobs:
update-swagger-doc:
name: Update Swagger doc
Comment on lines +10 to +11
Copy link
Member

Choose a reason for hiding this comment

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

기여해주신 워크플로우도 cb-tumblebug 리포지토리에서 동작하도록 제한할 필요성을 느낍니다 ^^

이유는 (본 워크플로우를 모르는) 기여자의 Forked repository에서 혹시라도 워크플로우가 수행되는 경우 Upstream와 forked간에 꼬이는 불상사를 방지하기 위함입니다.

Ref #895

Suggested change
update-swagger-doc:
name: Update Swagger doc
update-swagger-doc:
if: github.repository == 'cloud-barista/cb-tumblebug'
name: Update Swagger doc

if: github.repository == 'cloud-barista/cb-tumblebug'
runs-on: ubuntu-18.04
strategy:
matrix:
go-version: [ '1.17' ]
Copy link
Member

Choose a reason for hiding this comment

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

@seokho-son

혹시, Go version을 1.17으로 버전업 하셨을까요?

README의 실행 및 개발환경에 표기된 추천 Go version은 1.16으로 표기되어 있어 문의드립니다 ^^

Copy link
Member

Choose a reason for hiding this comment

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

@hermitkim1 아직 버전업 하지 않았습니다. 최신 릴리스에서 1단계 정도 낮게 가져가고 있습니다. (그래서 1.16)
저도 해당 워크플로우에서의 1.17을 사용하는 것으로 되어 있어서, 버전을 살짝 고민해보긴 했는데..

꼭 소스 구동 환경과 동일하게 맞출 필요는 없을 수도 있겠다는 생각입니다.. ^^
조만간 소스 구동 환경도 1.17로 올릴 가능성이 높기도 하구요 ^^

Copy link
Member

Choose a reason for hiding this comment

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

@computerphilosopher 기여해주신 1.17 유지해 주시고요 ^^


steps:
- name: Set up Go ${{ matrix.go-version }}
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go-version }}

- name: Checkout source code
uses: actions/checkout@v2.3.4

- name: Install swag
run: |
go install github.com/swaggo/swag/cmd/swag@latest
Copy link
Member

Choose a reason for hiding this comment

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

버전을 명시하는 것이 좋을 것 같습니다 ^^

Copy link
Member

Choose a reason for hiding this comment

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

저의 생각은..
이 라인에 버전을 명시해 놓으면
아마도 "GitHub Actions autoupdate" 의 자동 업데이트 기능으로는 업데이트가 되지 않을 것 같고
(uses: 필드에 써 있는 것은 자동 업데이트가 될텐데, run: 필드 밑에 써 있어서.. 😊)

예를 들어 이 라인에 v1.7.0 으로 적혀 있는데
기여자가 v1.7.1 을 이용하여 Swagger doc 을 업데이트 하면
이 workflow가 다시 v1.7.0 을 이용하여 Swagger doc 을 업데이트하는 일이 발생할 수도 있을 것 같아서

저는 latest 가 좋지 않을까 생각을 하였으며..
이 사안과 관련하여 @hermitkim1 님과 오프라인에서 이야기를 나누었습니다. 😊

Copy link
Member

Choose a reason for hiding this comment

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

@computerphilosopher 께서 원하시는 방향으로 진행하시면 될 것 같습니다 😄


- name: Update Swagger doc
run: |
cd src
make swag

- name: Commit generated Swagger docs
uses: stefanzweifel/git-auto-commit-action@v4
with:
file_pattern: src/api/rest/docs/**
commit_message: Update Swagger docs