Skip to content

๐Ÿ“docs : API Docs ์ˆ˜์ • #2

๐Ÿ“docs : API Docs ์ˆ˜์ •

๐Ÿ“docs : API Docs ์ˆ˜์ • #2

Workflow file for this run

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.json --output noti.yaml --ext yaml'
- name: Rename Yaml Title & Desc
run: |
yq -i '.info.title = "PetStore Backend API Document for FrontEnd"' fe.yaml
yq -i '.info.description = "Please contact Petstore backend if there are any issues with API"' fe.yaml
- name: redoc-cli-github-action
uses: seeebiii/redoc-cli-github-action@v9
with:
args: 'build-docs noti.yaml --output api-docs.html'
- name: save build result to tmp dir
run: |
cd ..
mkdir -p docs
mv ./noti-service/api-docs.html .
- name: Commit and push build artifacts
run: |
git add .
git commit -m "๐Ÿ“docs : Generate API Docs"
git push origin apiDocs