๐ docs : API ๋ฌธ์ ํตํฉ #13
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: 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: | |
| #์ ์ฅ์ ์ฝ๋๋ฅผ ๋ด๋ ค๋ฐ์ต๋๋ค. | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: docs/#44 | |
| #Java Set up | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'zulu' | |
| #Gradle ๋ช ๋ น์ด๋ก ApiDocs๋ฅผ ์์ฑํฉ๋๋ค. | |
| - name: get doc | |
| run: | | |
| cd ./noti-service | |
| cat ./build.gradle | |
| ls -all | |
| ./noti-service/gradlew :noti-service:clean :noti-service:generateOpenApiDocs | |
| #redoc Set up | |
| - name: redocly-cli | |
| # You may pin to the exact commit or the version. | |
| # uses: DeltaLaboratory/redocly-cli-action@34bfb03df7e3412b75b1f4086c3fd46e82fa5e33 | |
| uses: DeltaLaboratory/[email protected] | |
| - 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 |