Skip to content

📝 docs : API 문서 통합 #51

📝 docs : API 문서 통합

📝 docs : API 문서 통합 #51

Workflow file for this run

name: API Docs Integration

Check failure on line 1 in .github/workflows/apiDocs.yml

View workflow run for this annotation

GitHub Actions / .github/workflows/apiDocs.yml

Invalid workflow file

You have an error in your yaml syntax
on:
push:
branches:
- develop
jobs:
api-docs-integration:
runs-on: ubuntu-latest
steps:
# 프로젝트 코드 가져오기
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: 'develop'
# Json 파일 가져오기
- name : collect json
run : |
cp ./noti-service/docs/noti.json ./
cp ./user-service/docs/user.json ./
cp ./weather-service/docs/weather.json ./
# Redoc : json 파일 join
- name: redoc-cli join
uses: DeltaLaboratory/[email protected]
with:
args: 'join *.json -o api.yaml'
#결과 검사
- name: check result
run: |
ls -al
test -f api.yaml || (echo "Missing api.yaml from previous step." && exit 1)
# Redoc : build-dcos
- name: redoc-cli build docs
uses: DeltaLaboratory/[email protected]
with:
args: 'build-docs api.yaml -o index.html'
#결과 검사
- name: check result
run: |
ls -al
test -f index.html || (echo "Missing index.html from previous step." && exit 1)
# 웹페이지 Repository에 Push
- name: Install SSH Key
uses: leigholiver/[email protected]
with:
source: index.html
destination_folder: docs
destination_repo: WaitherTeam/WaitherTeam.github.io
destination_branch: main
deploy_key: ${{ secrets.DEPLOY_KEY }}