add global options for shared connection pool size and idle timeout #127
This file contains hidden or 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: VDI API Docs | |
| on: | |
| workflow_dispatch: {} | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/vdi-api.html' | |
| - 'project/common/config/src/main/json/schema/**' | |
| - 'project/core/module/rest-service/api-schema/**' | |
| - 'project/core/module/rest-service/*.raml' | |
| - '.github/workflows/api-docs.yml' | |
| jobs: | |
| build: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| env: | |
| DOC_BUILD_DIR: ${{github.workspace}}/build/generated-docs | |
| steps: | |
| - name: Clone Repo | |
| uses: actions/checkout@v4 | |
| - name: Install Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: '25' | |
| distribution: corretto | |
| - name: Install Gradle | |
| uses: gradle/actions/setup-gradle@v4 | |
| with: | |
| cache-read-only: false | |
| - name: Install Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install Schema Doc Generator | |
| run: pip install git+https://github.com/Foxcapades/json-schema-for-humans | |
| - name: Install NPM | |
| uses: actions/setup-node@v4 | |
| - name: Install NPM Packages | |
| shell: bash | |
| run: npm i -g raml2html raml2html-modern-theme | |
| - name: Generate Server Docs | |
| env: | |
| GH_USERNAME: ${{ secrets.GH_USERNAME }} | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| run: >- | |
| gradle -P DOC_BUILD_DIR=$DOC_BUILD_DIR/core \ | |
| -P DOC_FILE_NAME=index.html \ | |
| :core:generate-raml-docs | |
| - name: Merge and Convert JSON Schema | |
| run: |- | |
| gradle -P SCHEMA_BUILD_DIR=$DOC_BUILD_DIR \ | |
| :common:config:compile-config-schema | |
| - name: Generate Configuration Docs | |
| run: >- | |
| generate-schema-doc \ | |
| --config expand_buttons \ | |
| --config examples_as_yaml \ | |
| --config no_link_to_reused_ref \ | |
| $DOC_BUILD_DIR/schema/config/full-config.json \ | |
| $DOC_BUILD_DIR/schema/config/full-config.html | |
| generate-schema-doc \ | |
| --config expand_buttons \ | |
| --config examples_as_yaml \ | |
| --config no_link_to_reused_ref \ | |
| $DOC_BUILD_DIR/schema/config/plugin-config.json \ | |
| $DOC_BUILD_DIR/schema/config/plugin-config.html | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ${{ env.DOC_BUILD_DIR }} | |
| deploy: | |
| name: Deploy | |
| runs-on: ubuntu-latest | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@v4 |