[Docs] Documentation migration from RTD to ESP-Docs #1
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
| name: Documentation Deploy CI | ||
| // Deploy to production on each merge to master | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/docs_deploy.yml' | ||
| jobs: | ||
| deploy-preview-docs: | ||
| name: Deploy Documentation | ||
| runs-on: ubuntu-22.04 | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| submodules: true | ||
| - uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.10' | ||
| - name: Deploy Preview | ||
| env: | ||
| # Deploy to production server | ||
| # DOCS_BUILD_DIR: "./docs/_build/" | ||
| # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }} | ||
| # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} | ||
| # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_SERVER_USER }} | ||
| # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} | ||
| # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} | ||
| # Deploy to preview server | ||
| DOCS_BUILD_DIR: "./docs/_build/" | ||
| DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PREV_DEPLOY_KEY }} | ||
| DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PREV_SERVER }} | ||
| DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PREV_SERVER_USER }} | ||
| DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PREV_PATH }} | ||
| DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PREV_URL }} | ||
| run: | | ||
| sudo apt update | ||
| sudo apt install python3-pip python3-setuptools | ||
| source ./docs/utils.sh | ||
| add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER | ||
| export GIT_VER=$(git describe --always) | ||
| echo "PIP install requirements..." | ||
| pip3 install --user -r ./docs/requirements.txt | ||
| echo "Building the Docs..." | ||
| cd ./docs && build-docs -l en | ||
| echo "Deploy the Docs..." | ||
| deploy-docs | ||
