Merge pull request #261 from stargate/rest-doc-api-updates #282
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 Antora site | |
| on: | |
| push: | |
| branches: | |
| - main | |
| env: | |
| SITE_DIR: 'stargate' | |
| SUB_DIR: 'latest' | |
| jobs: | |
| build_site: | |
| name: "Build site with Antora" | |
| runs-on: [ubuntu-latest] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: "Render redoc with cli" | |
| run: | | |
| npm install --location=global redoc-cli | |
| redoc-cli build api/StargateRESTv2.yaml --output docs-src/stargate-develop/modules/develop/attachments/restv2.html | |
| redoc-cli build api/StargateRESTv1.yaml --output docs-src/stargate-develop/modules/develop/attachments/restv1.html | |
| redoc-cli build api/StargateDocv2.yaml --output docs-src/stargate-develop/modules/develop/attachments/docv2.html | |
| - name: "Switch antora.yml" | |
| run: | | |
| FILE=antora.yml | |
| cd $GITHUB_WORKSPACE/docs-src/stargate-core | |
| if [ -f "$FILE" ]; then | |
| rm antora.yml; | |
| echo "antora.yml removed" | |
| fi | |
| ln -s antora-stargate.yml antora.yml | |
| echo "symlink created" | |
| cd $GITHUB_WORKSPACE/docs-src/stargate-develop | |
| if [ -f "$FILE" ]; then | |
| rm antora.yml; | |
| echo "antora.yml removed" | |
| fi | |
| ln -s antora-stargate.yml antora.yml | |
| echo "symlink created" | |
| cd $GITHUB_WORKSPACE | |
| - name: "Generate site using antora site action" | |
| uses: riptano/antora-site-action@main | |
| with: | |
| antora_playbook: playbooks/site-local-stargate.yaml | |
| - name: "List folder" | |
| run: | | |
| ls -ltra $GITHUB_WORKSPACE/build/$SITE_DIR/$SUB_DIR/develop | |
| - name: "Fix attachments" | |
| run: | | |
| sudo mv $GITHUB_WORKSPACE/build/$SITE_DIR/$SUB_DIR/develop/_attachments $GITHUB_WORKSPACE/build/$SITE_DIR/$SUB_DIR/develop/attachments | |
| sudo sed -i 's/_attachments/attachments/g' $GITHUB_WORKSPACE/build/$SITE_DIR/$SUB_DIR/develop/api.html | |
| ls -ltra $GITHUB_WORKSPACE/build/$SITE_DIR | |
| grep attachment $GITHUB_WORKSPACE/build/$SITE_DIR/$SUB_DIR/develop/api.html | |
| - name: "Copy index.html required for website" | |
| run: | | |
| sudo mv $GITHUB_WORKSPACE/index.html $GITHUB_WORKSPACE/build/$SITE_DIR | |
| ls -ltra $GITHUB_WORKSPACE/build/$SITE_DIR | |
| - name: "Upload generated site" | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: site | |
| path: "${{ github.workspace }}/build/${{ env.SITE_DIR }}" | |
| deploy_site: | |
| runs-on: [ubuntu-latest] | |
| needs: [build_site] | |
| name: "Deploy GitHub Pages" | |
| steps: | |
| - name: Setup Node.js for use with actions | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 16 | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Download generated site | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: site | |
| path: "${{ github.workspace }}/${{ env.SITE_DIR }}" | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| with: | |
| # ACCESS_TOKEN: # optional | |
| token: "${{ github.token}}" | |
| folder: "${{ env.SITE_DIR }}" | |
| branch: 'gh-pages' | |
| commit-message: "[CI] Publish documentation for ${{ github.sha }}" |