๐docs : api docs ์์ #7
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: API Docs Integration | |
on: | |
push: | |
branches: | |
- docs/#44 | |
jobs: | |
document: | |
runs-on: ubuntu-latest | |
steps: | |
# ํ๋ก์ ํธ ์ฝ๋๋ฅผ ๊ฐ์ ธ์ต๋๋ค. | |
- name: Checkout Code | |
uses: actions/checkout@v3 | |
with: | |
ref: 'docs/#44' | |
# - name: move to docs directory | |
# run: | | |
# cd ./noti-service/docs | |
- name: redoc-cli-github-action | |
uses: seeebiii/redoc-cli-github-action@v9 | |
with: | |
args: 'bundle ./noti-service/docs/noti.json --output ./noti-service/docs/noti.yaml --ext yaml' | |
# - name: Rename Yaml Title & Desc | |
# run: | | |
# cat ./noti-service/docs/noti.yaml | |
# yq -i '.info.title = "PetStore Backend API Document for FrontEnd"' ./noti-service/docs/noti.yaml | |
# yq -i '.info.description = "Please contact Petstore backend if there are any issues with API"' ./noti-service/docs/noti.yaml | |
- name: redoc-cli-github-action | |
uses: seeebiii/redoc-cli-github-action@v9 | |
with: | |
args: 'build-docs ./noti-serivce/docs/noti.yaml --output ./api-docs.html' | |
- name: save build result to tmp dir | |
run: | | |
mkdir -p docs | |
mv ./api-docs.html ./docs | |
- name: Commit and push build artifacts | |
run: | | |
git add . | |
git commit -m "๐docs : Generate API Docs" | |
git push origin apiDocs |