Merge pull request #212 from vsmalladi/211-readme #41
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: Build OpenAPI docs | |
| on: | |
| - push | |
| # - pull_request | |
| jobs: | |
| docs-build: | |
| runs-on: ubuntu-latest | |
| # env: | |
| # TRAVIS_BRANCH: ${{ github.event.number }} | |
| # a trick that builds docs for PRs (with PR number). Does not work for PRs from forks. | |
| steps: | |
| - name: Setup Node.js environment | |
| uses: actions/[email protected] | |
| with: | |
| node-version: 14.x | |
| # Comes with npm 6. For newer Node, encountered: https://github.com/npm/cli/issues/3359 | |
| - run: npm install -g @redocly/openapi-cli && npm install -g redoc-cli | |
| - run: npm install -g gh-openapi-docs | |
| - name: Check out repository code | |
| uses: actions/checkout@v2 | |
| - run: gh-openapi-docs | |
| - name: Deploy 🚀 | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: . |