Skip to content

📝docs : 경로 변경 #5

📝docs : 경로 변경

📝docs : 경로 변경 #5

Workflow file for this run

name: generate noti-service api docs
on:
push:
branches:
- docs/#44
- develop
workflow_dispatch:
inputs:
branch:
description: 'Input branch info you want to generate'
required: true
jobs:
document:
runs-on: ubuntu-latest
steps:
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'zulu'
- name: get doc
run: |
ls
noti-service/gradlew :noti-service:clean :noti-service:generateOpenApiDocs
- name: generate document html
run: |
cp noti-service/build/docs/noti.json ./
redocly bundle noti.json --output noti.yaml --ext yaml
yq -i '.info.title = "Noti-Service API Document"' noti.yaml
yq -i '.info.description = "Please contact Petstore backend if there are any issues with API"' noti.yaml
redocly build-docs noti.yaml --output noti.html
- name: save build result to tmp dir
run: |
mkdir -p ../docs
mv noti.html ../docs
- name: Checkout document branch
uses: actions/checkout@v3
# with:
# ref: 'main'
# - name: Move build artifacts
# run: |
# mkdir -p petstore # replace with your target path
# cp -R -f ../../_temp/petstore-fe.html petstore/fe.html
#
# - name: Commit and push build artifacts
# run: |
# git config user.name "GitHub Actions"
# git config user.email "[email protected]"
# git add .
# git commit -m "Commit document artifacts"
# git push