Update docs with select star option #22
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 Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| # Credit: https://gohugo.io/hosting-and-deployment/hosting-on-github/ | |
| # Allow only one concurrent deployment, skipping runs queued between the run | |
| # in-progress and latest queued. However, do NOT cancel in-progress runs as we | |
| # want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Compile redoc | |
| - uses: actions/setup-node@v4 | |
| - run: npx @redocly/cli build-docs openapi.yaml | |
| working-directory: httpapi/v2 | |
| - run: mv httpapi/v2/redoc-static.html docs/static/api-reference.html | |
| # Compile hugo website | |
| - name: Setup Hugo | |
| run: sudo snap install hugo | |
| - name: Copy existing readme | |
| run: cp README.md docs/content/_index.md | |
| - name: Copy configuration | |
| run: sed -i -e '/__REPLACE__/{r config/singleServer.yaml' -e 'd}' docs/content/docs/configuration.md | |
| - name: Add GA ID from repo variables | |
| if: ${{ vars.DOCS_GA_ID }} | |
| run: sed -i "s/__REPLACE_GA_ID__/${{ vars.DOCS_GA_ID }}/" docs/hugo.yaml | |
| - name: Build website | |
| working-directory: docs | |
| run: hugo | |
| - name: Setup pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/public | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |