docs: adds docs for uuid flag #1273
Workflow file for this run
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
| #********************************************************************* | |
| # Copyright (c) Intel Corporation 2020 | |
| # SPDX-License-Identifier: Apache-2.0 | |
| #*********************************************************************/ | |
| # This is a basic workflow to help you get started with Actions | |
| name: Docs-Build | |
| # Controls when the action will run. Triggers the workflow on push or pull request | |
| # events but only for the main branch | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: [ main ] | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| # Runs a single command using the runners shell | |
| - name: Run a one-line script | |
| run: | | |
| pip install mkdocs-material==8.5.6 | |
| pip install mkdocs-render-swagger-plugin | |
| pip install mkdocs-macros-plugin | |
| pip install mkdocs-mermaid2-plugin | |
| pip install mkdocs-img2fig-plugin | |
| mkdocs build --strict | |
| #checkout the gh-pages branch | |
| - uses: actions/checkout@v2 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| path: 'to-be-published' | |
| ref: 'gh-pages' | |
| #copy the built site content | |
| - name: Copy | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| run: cp -rlf site/* ./to-be-published/ | |
| #publish it | |
| - name: Publish content | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| run: | | |
| cd ./to-be-published | |
| git config user.name github-actions | |
| git config user.email [email protected] | |
| git add . | |
| git commit -m 'ci: ${{github.event.head_commit.message}}' | |
| git push origin gh-pages |