From d42a35bf2306e22f848f06b67e5cd2e2d03c3b3e Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 08:44:35 +0000 Subject: [PATCH 01/24] Added back the deploy on PR --- .github/workflows/docs_preview.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 41de91838b3..dcf1795c6ea 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -1,6 +1,10 @@ name: Documentation Build and Deploy CI on: + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' push: branches: - master From 75fdc6a7c1a256ed873495810dcea07ce75ef34c Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 08:53:07 +0000 Subject: [PATCH 02/24] Added back the deploy on PR --- .github/workflows/docs_preview.yml | 51 ++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index dcf1795c6ea..10381d4cee1 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -1,21 +1,50 @@ name: Documentation Build and Deploy CI on: - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' push: branches: - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: paths: - 'docs/**' - '.github/workflows/docs.yml' jobs: + build-docs: + name: Build ESP-Docs + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Build + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + cd ./docs + PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary + PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en + - name: Archive Docs + uses: actions/upload-artifact@v2 + with: + name: docs + path: docs + deploy-preview-docs: - name: Deploy Documentation Preview + name: Deploy Documentation runs-on: ubuntu-22.04 defaults: run: @@ -29,8 +58,16 @@ jobs: 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: "${CI_PROJECT_DIR}/docs/_build/" + TYPE: "preview" + # DOCS_BUILD_DIR: "./docs/_build" DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} @@ -47,4 +84,6 @@ jobs: echo "Building the Docs..." cd ./docs && build-docs -l en echo "Deploy the Docs..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs deploy-docs From 61a0a8f7f933b22faf10580c2db7f12cac9fc0fa Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 08:56:35 +0000 Subject: [PATCH 03/24] Added back the deploy on PR - Clean CI --- .github/workflows/allboards.yml | 92 ------------ .github/workflows/boards.yml | 71 --------- .github/workflows/build_py_tools.yml | 141 ------------------ .github/workflows/dangerjs.yml | 22 --- .../workflows/{docs_preview.yml => docs.yml} | 0 .github/workflows/docs_preview copy.yml | 89 +++++++++++ .github/workflows/gh-pages.yml | 23 --- .github/workflows/hil.yml | 118 --------------- .github/workflows/lib.json | 66 -------- .github/workflows/lib.yml | 135 ----------------- .github/workflows/publish.yml | 38 ----- .github/workflows/publishlib.yml | 41 ----- .github/workflows/push.yml | 112 -------------- .github/workflows/release.yml | 22 --- .github/workflows/upload-idf-component.yml | 20 --- 15 files changed, 89 insertions(+), 901 deletions(-) delete mode 100644 .github/workflows/allboards.yml delete mode 100644 .github/workflows/boards.yml delete mode 100644 .github/workflows/build_py_tools.yml delete mode 100644 .github/workflows/dangerjs.yml rename .github/workflows/{docs_preview.yml => docs.yml} (100%) create mode 100644 .github/workflows/docs_preview copy.yml delete mode 100644 .github/workflows/gh-pages.yml delete mode 100644 .github/workflows/hil.yml delete mode 100644 .github/workflows/lib.json delete mode 100644 .github/workflows/lib.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/publishlib.yml delete mode 100644 .github/workflows/push.yml delete mode 100644 .github/workflows/release.yml delete mode 100644 .github/workflows/upload-idf-component.yml diff --git a/.github/workflows/allboards.yml b/.github/workflows/allboards.yml deleted file mode 100644 index 49370120339..00000000000 --- a/.github/workflows/allboards.yml +++ /dev/null @@ -1,92 +0,0 @@ -name: Boards Test - Remote trigger - -# The workflow will run on remote dispath with event-type set to "test-boards" -on: - repository_dispatch: - types: [test-boards] - -jobs: - find-boards: - runs-on: ubuntu-latest - - outputs: - fqbns: ${{ env.FQBNS }} - board-count: ${{ env.BOARD-COUNT }} - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - with: - ref: ${{ github.event.client_payload.branch }} - - - name: Get boards fqbns - run: - bash .github/scripts/find_all_boards.sh - - setup-chunks: - needs: find-boards - runs-on: ubuntu-latest - if: needs.find-boards.outputs.fqbns != '' - - outputs: - test-chunks: ${{ steps['set-test-chunks'].outputs['test-chunks'] }} - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - with: - ref: ${{ github.event.client_payload.branch }} - - - run: npm install - - name: Setup jq - uses: dcarbone/install-jq-action@v1.0.1 - - - id: set-test-chunks - name: Set Chunks - run: - echo "test-chunks<> $GITHUB_OUTPUT - - echo "$( jq -nc '${{ needs.find-boards.outputs.fqbns }} | [_nwise( ${{ needs.find-boards.outputs.board-count }}/15 | ceil)]')" >> $GITHUB_OUTPUT - - echo "EOF" >> $GITHUB_OUTPUT - - test-boards: - needs: setup-chunks - runs-on: ubuntu-latest - - env: - REPOSITORY: | - - source-path: '.' - name: "espressif:esp32" - - strategy: - fail-fast: false - matrix: - chunk: ${{ fromJSON(needs.setup-chunks.outputs['test-chunks']) }} - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - with: - ref: ${{ github.event.client_payload.branch }} - - - name: Echo FQBNS to file - run: - echo "$FQBN" > fqbns.json - env: - FQBN: ${{ toJSON(matrix.chunk) }} - - - name: Compile sketch - uses: P-R-O-C-H-Y/compile-sketches@main - with: - platforms: | - ${{ env.REPOSITORY }} - multiple-fqbn: true - multiple-fqbn-path: "fqbns.json" - use-json-file: false - enable-deltas-report: false - enable-warnings-report: false - cli-compile-flags: | - - --warnings="all" - sketch-paths: - "- ./libraries/ESP32/examples/CI/CIBoardsTest/CIBoardsTest.ino" diff --git a/.github/workflows/boards.yml b/.github/workflows/boards.yml deleted file mode 100644 index 3e189231932..00000000000 --- a/.github/workflows/boards.yml +++ /dev/null @@ -1,71 +0,0 @@ -name: Boards Test - -# The workflow will run on schedule and labeled pull requests -on: - pull_request: - -env: - # It's convenient to set variables for values used multiple times in the workflow - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - -jobs: - find-boards: - runs-on: ubuntu-latest - - outputs: - fqbns: ${{ env.FQBNS }} - - steps: - # This step makes the contents of the repository available to the workflow - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Setup jq - uses: dcarbone/install-jq-action@v1.0.1 - - - name: Get board name - run: - bash .github/scripts/find_new_boards.sh ${{ github.repository }} ${{github.event.number}} - - test-boards: - needs: find-boards - runs-on: ubuntu-latest - if: needs.find-boards.outputs.fqbns != '' - - env: - REPOSITORY: | - - source-path: '.' - name: "espressif:esp32" - - strategy: - matrix: ${{ fromJson(needs.find-boards.outputs.fqbns) }} - - steps: - # This step makes the contents of the repository available to the workflow - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Check if build.board is uppercase - run: | - board_name=$(echo ${{ matrix.fqbn }} | awk -F':' '{print $NF}') - if grep -q "^$board_name.build.board=[A-Z0-9_]*$" boards.txt; then - echo "$board_name.build.board is valid."; - else - echo "Error: $board_name.build.board is not uppercase!"; - exit 1; - fi - - - name: Compile sketch - uses: P-R-O-C-H-Y/compile-sketches@main - with: - platforms: | - ${{ env.REPOSITORY }} - fqbn: ${{ matrix.fqbn }} - use-json-file: false - enable-deltas-report: false - enable-warnings-report: false - cli-compile-flags: | - - --warnings="all" - exit-on-fail: true - sketch-paths: - "- ./libraries/ESP32/examples/CI/CIBoardsTest/CIBoardsTest.ino" diff --git a/.github/workflows/build_py_tools.yml b/.github/workflows/build_py_tools.yml deleted file mode 100644 index 46ecf6da756..00000000000 --- a/.github/workflows/build_py_tools.yml +++ /dev/null @@ -1,141 +0,0 @@ -name: Build Python Tools - -on: - pull_request: - paths: - - 'tools/get.py' - - 'tools/espota.py' - - 'tools/gen_esp32part.py' - - 'tools/gen_insights_package.py' - -jobs: - find-changed-tools: - name: Check if tools have been changed - runs-on: ubuntu-20.04 - outputs: - any_changed: ${{ steps.verify-changed-files.outputs.any_changed }} - all_changed_files: ${{ steps.verify-changed-files.outputs.all_changed_files }} - steps: - - name: Checkout repository - uses: actions/checkout@v3 - with: - fetch-depth: 2 - ref: ${{ github.event.pull_request.head.ref }} - - name: Verify Python Tools Changed - uses: tj-actions/changed-files@v41 - id: verify-changed-files - with: - fetch_depth: '2' - since_last_remote_commit: 'true' - files: | - tools/get.py - tools/espota.py - tools/gen_esp32part.py - tools/gen_insights_package.py - - name: List all changed files - shell: bash - run: | - for file in ${{ steps.verify-changed-files.outputs.all_changed_files }}; do - echo "$file was changed" - done - - build-pytools-binaries: - name: Build python tools binaries for ${{ matrix.os }} - runs-on: ${{ matrix.os }} - needs: find-changed-tools - if: needs.find-changed-tools.outputs.any_changed == 'true' - strategy: - fail-fast: false - matrix: - os: [windows-latest, macos-latest, ubuntu-20.04, ARM, ARM64] - include: - - os: windows-latest - TARGET: win64 - EXTEN: .exe - SEPARATOR: ';' - - os: macos-latest - TARGET: macos - SEPARATOR: ':' - - os: ubuntu-20.04 - TARGET: linux-amd64 - SEPARATOR: ':' - - os: ARM - CONTAINER: python:3.8-bullseye - TARGET: arm - SEPARATOR: ':' - - os: ARM64 - CONTAINER: python:3.8-bullseye - TARGET: arm64 - SEPARATOR: ':' - container: ${{ matrix.CONTAINER }} # use python container on ARM - env: - DISTPATH: pytools-${{ matrix.TARGET }} - PIP_EXTRA_INDEX_URL: "https://dl.espressif.com/pypi" - steps: - - name: List changed tools - shell: bash - run: | - CHANGED_FILES=() - for file in ${{ needs.find-changed-tools.outputs.all_changed_files }}; do - file="${file#*\/}" - file="${file%\.*}" - CHANGED_FILES+=("$file") - done - CHANGED_FILES="${CHANGED_FILES[@]}" - echo "CHANGED_TOOLS=$CHANGED_FILES" >> "$GITHUB_ENV" - for tool in ${{ env.CHANGED_TOOLS }}; do - echo "tool $tool was changed" - done - - name: Checkout repository - uses: actions/checkout@v3 - with: - ref: ${{ github.event.pull_request.head.ref }} - - name: Set up Python 3.8 - # Skip setting python on ARM because of missing compatibility: https://github.com/actions/setup-python/issues/108 - if: matrix.os != 'ARM' && matrix.os != 'ARM64' - uses: actions/setup-python@master - with: - python-version: 3.8 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install pyinstaller requests - - name: Build with PyInstaller - shell: bash - run: | - for tool in ${{ env.CHANGED_TOOLS }}; do - pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=.github/pytools/espressif.ico tools/$tool.py - done - - name: Sign binaries - if: matrix.os == 'windows-latest' - env: - CERTIFICATE: ${{ secrets.CERTIFICATE }} - CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }} - shell: pwsh - run: | - $data = Write-Output ${{ env.CHANGED_TOOLS }} - foreach ( $node in $data ) - { - ./.github/pytools/Sign-File.ps1 -Path ./${{ env.DISTPATH }}/$node.exe - } - - name: Test binaries - shell: bash - run: | - for tool in ${{ env.CHANGED_TOOLS }}; do - ./${{ env.DISTPATH }}/$tool${{ matrix.EXTEN }} -h - done - - name: Push binary to tools - if: matrix.os == 'windows-latest' - env: - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - shell: bash - run: | - for tool in ${{ env.CHANGED_TOOLS }}; do - cp -f ./${{ env.DISTPATH }}/$tool.exe tools/$tool.exe - done - bash .github/scripts/upload_py_tools.sh "${{ env.CHANGED_TOOLS }}" - - name: Archive artifact - uses: actions/upload-artifact@master - with: - name: ${{ env.DISTPATH }} - path: ${{ env.DISTPATH }} diff --git a/.github/workflows/dangerjs.yml b/.github/workflows/dangerjs.yml deleted file mode 100644 index 9f7360bc34f..00000000000 --- a/.github/workflows/dangerjs.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: DangerJS Pull Request linter -on: - pull_request_target: - types: [opened, edited, reopened, synchronize] - -permissions: - pull-requests: write - contents: write - -jobs: - pull-request-style-linter: - runs-on: ubuntu-latest - steps: - - name: Check out PR head - uses: actions/checkout@v4 - with: - ref: ${{ github.event.pull_request.head.sha }} - - - name: DangerJS pull request linter - uses: espressif/shared-github-dangerjs@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs.yml similarity index 100% rename from .github/workflows/docs_preview.yml rename to .github/workflows/docs.yml diff --git a/.github/workflows/docs_preview copy.yml b/.github/workflows/docs_preview copy.yml new file mode 100644 index 00000000000..10381d4cee1 --- /dev/null +++ b/.github/workflows/docs_preview copy.yml @@ -0,0 +1,89 @@ +name: Documentation Build and Deploy CI + +on: + push: + branches: + - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + +jobs: + + build-docs: + name: Build ESP-Docs + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Build + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + cd ./docs + PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary + PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en + - name: Archive Docs + uses: actions/upload-artifact@v2 + with: + name: docs + path: docs + + deploy-preview-docs: + name: Deploy Documentation + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + 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 + TYPE: "preview" + # DOCS_BUILD_DIR: "./docs/_build" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + 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..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs + deploy-docs diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml deleted file mode 100644 index cea5e1eac86..00000000000 --- a/.github/workflows/gh-pages.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: GitHub Pages CI - -on: - push: - branches: - - master - - pages - paths: - - 'README.md' - - '.github/scripts/on-pages.sh' - - '.github/workflows/gh-pages.yml' - -jobs: - - build-pages: - name: Build GitHub Pages - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: Copy Files - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: bash ./.github/scripts/on-pages.sh diff --git a/.github/workflows/hil.yml b/.github/workflows/hil.yml deleted file mode 100644 index 10c937f1bfe..00000000000 --- a/.github/workflows/hil.yml +++ /dev/null @@ -1,118 +0,0 @@ -name: Run tests in hardware - -on: - pull_request: - types: [opened, reopened, synchronize, labeled] - - schedule: - - cron: '0 2 * * *' - -env: - MAX_CHUNKS: 15 - -concurrency: - group: hil-${{github.event.pull_request.number || github.ref}} - cancel-in-progress: true - -jobs: - gen_chunks: - if: | - contains(github.event.pull_request.labels.*.name, 'hil_test') || - (github.event_name == 'schedule' && github.repository == 'espressif/arduino-esp32') - name: Generate Chunks matrix - runs-on: ubuntu-latest - outputs: - chunks: ${{ steps.gen-chunks.outputs.chunks }} - steps: - - name: Checkout Repository - uses: actions/checkout@v3 - - - name: Generate Chunks matrix - id: gen-chunks - run: | - set +e - .github/scripts/sketch_utils.sh count tests - sketches=$? - if [[ $sketches -ge ${{env.MAX_CHUNKS}} ]]; then - $sketches=${{env.MAX_CHUNKS}} - fi - set -e - rm sketches.txt - CHUNKS=$(jq -c -n '$ARGS.positional' --args `seq 0 1 $((sketches - 1))`) - echo "chunks=${CHUNKS}" >>$GITHUB_OUTPUT - - Build: - needs: gen_chunks - name: ${{matrix.chip}}-Build#${{matrix.chunks}} - runs-on: ubuntu-latest - strategy: - matrix: - chip: ['esp32', 'esp32s2', 'esp32s3', 'esp32c3', 'esp32c6', 'esp32h2'] - chunks: ${{fromJson(needs.gen_chunks.outputs.chunks)}} - steps: - - name: Checkout Repository - uses: actions/checkout@v3 - - name: Build sketches - run: | - bash .github/scripts/tests_build.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} - - name: Upload ${{matrix.chip}}-${{matrix.chunks}} artifacts - uses: actions/upload-artifact@v3 - with: - name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts - path: | - ~/.arduino/tests/*/build*.tmp/*.bin - ~/.arduino/tests/*/build*.tmp/*.json - if-no-files-found: error - Test: - needs: [gen_chunks, Build] - name: ${{matrix.chip}}-Test#${{matrix.chunks}} - strategy: - fail-fast: false - matrix: - chip: ['esp32', 'esp32s2', 'esp32s3', 'esp32c3', 'esp32c6', 'esp32h2'] - chunks: ${{fromJson(needs.gen_chunks.outputs.chunks)}} - runs-on: [arduino, "${{matrix.chip}}"] - container: - image: python:3.10.1-bullseye - options: --privileged - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Download ${{matrix.chip}}-${{matrix.chunks}} artifacts - uses: actions/download-artifact@v3 - with: - name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts - path: ~/.arduino/tests/ - - - name: Install dependencies - run: | - pip install -U pip - pip install -r tests/requirements.txt --extra-index-url https://dl.espressif.com/pypi - apt update && apt install -y -qq jq - - - name: Run Tests - run: | - bash .github/scripts/tests_run.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} -e - - - name: Upload test result artifacts - uses: actions/upload-artifact@v3 - if: always() - with: - name: test_results-${{matrix.chip}}-${{matrix.chunks}} - path: tests/*/*.xml - - event_file: - name: "Event File" - if: | - contains(github.event.pull_request.labels.*.name, 'hil_test') || - github.event_name == 'schedule' - needs: Test - runs-on: ubuntu-latest - steps: - - name: Upload - uses: actions/upload-artifact@v3 - with: - name: Event File - path: ${{github.event_path}} diff --git a/.github/workflows/lib.json b/.github/workflows/lib.json deleted file mode 100644 index 453267a2d2d..00000000000 --- a/.github/workflows/lib.json +++ /dev/null @@ -1,66 +0,0 @@ -[ - { - "name": "Adafruit NeoPixel", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/Adafruit_NeoPixel/examples/strandtest/strandtest.ino" - ] - }, - { - "name": "ArduinoBLE", - "exclude_targets": [ - "esp32s2" - ], - "sketch_path": [ - "~/Arduino/libraries/ArduinoBLE/examples/Central/Scan/Scan.ino" - ] - }, - { - "name": "ESP32Servo", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/ESP32Servo/examples/Multiple-Servo-Example-Arduino/Multiple-Servo-Example-Arduino.ino" - ] - }, - { - "source-url": "https://github.com/me-no-dev/ESPAsyncWebServer.git", - "required-libs": [ - {"source-url": "https://github.com/me-no-dev/AsyncTCP.git"} - ], - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/ESPAsyncWebServer/examples/CaptivePortal/CaptivePortal.ino", - "~/Arduino/libraries/ESPAsyncWebServer/examples/ESP_AsyncFSBrowser/ESP_AsyncFSBrowser.ino", - "~/Arduino/libraries/ESPAsyncWebServer/examples/regex_patterns/regex_patterns.ino", - "~/Arduino/libraries/ESPAsyncWebServer/examples/simple_server/simple_server.ino" - ] - }, - { - "name": "FastLED", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/FastLED/examples/Blink/Blink.ino" - ] - }, - { - "name": "IRremote", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/IRremote/examples/SendDemo/SendDemo.ino" - ] - }, - { - "name": "MFRC522", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/MFRC522/examples/ReadUidMultiReader/ReadUidMultiReader.ino" - ] - }, - { - "name": "WS2812FX", - "exclude_targets": [], - "sketch_path": [ - "~/Arduino/libraries/WS2812FX/examples/ws2812fx_spi/ws2812fx_spi.ino" - ] - } -] \ No newline at end of file diff --git a/.github/workflows/lib.yml b/.github/workflows/lib.yml deleted file mode 100644 index 5e44e705e29..00000000000 --- a/.github/workflows/lib.yml +++ /dev/null @@ -1,135 +0,0 @@ -name: External Libraries Test - -# The workflow will run on schedule and labeled pull requests -on: - pull_request: - types: [opened, reopened, synchronize, labeled] - - # Schedule weekly builds on every Sunday at 4 am - schedule: - - cron: '0 4 * * SUN' - -env: - # It's convenient to set variables for values used multiple times in the workflow - SKETCHES_REPORTS_PATH: libraries-report - SKETCHES_REPORTS_ARTIFACT_NAME: libraries-report - RESULT_LIBRARY_TEST_FILE: LIBRARIES_TEST.md - JSON_LIBRARY_LIST_FILE: .github/workflows/lib.json - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - -jobs: - compile-sketch: - if: | - contains(github.event.pull_request.labels.*.name, 'lib_test') || - (github.event_name == 'schedule' && github.repository == 'espressif/arduino-esp32') - runs-on: ubuntu-latest - - env: - REPOSITORY: | - - source-path: '.' - name: "espressif:esp32" - - strategy: - matrix: - target: - - esp32 - - esp32s2 - - esp32c3 - - esp32s3 - - esp32c6 - - esp32h2 - - include: - - target: esp32 - fqbn: espressif:esp32:esp32 - - target: esp32s2 - fqbn: espressif:esp32:esp32s2 - - target: esp32c3 - fqbn: espressif:esp32:esp32c3 - - target: esp32s3 - fqbn: espressif:esp32:esp32s3 - - target: esp32c6 - fqbn: espressif:esp32:esp32c6 - - target: esp32h2 - fqbn: espressif:esp32:esp32h2 - - - steps: - # This step makes the contents of the repository available to the workflow - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Compile sketch - uses: P-R-O-C-H-Y/compile-sketches@main - with: - platforms: | - ${{ env.REPOSITORY }} - target: ${{ matrix.target }} - fqbn: ${{ matrix.fqbn }} - use-json-file: true - json-path: ${{ env.JSON_LIBRARY_LIST_FILE }} - enable-deltas-report: true - sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} - enable-warnings-report: true - cli-compile-flags: | - - --warnings="all" - - - name: Upload artifact - uses: actions/upload-artifact@v3 - with: - name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }} - path: ${{ env.SKETCHES_REPORTS_PATH }} - - report-to-file: - needs: compile-sketch # Wait for the compile job to finish to get the data for the report - if: github.event_name == 'schedule' # Only run the job when the workflow is triggered by a schedule - runs-on: ubuntu-latest - steps: - # Check out repository - - name: Checkout repository - uses: actions/checkout@v3 - with: - token: ${{ env.GITHUB_TOKEN }} - fetch-depth: '0' - - - name: Switch branch - run: - git checkout remotes/origin/gh-pages - - # This step is needed to get the size data produced by the compile jobs - - name: Download sketches reports artifact - uses: actions/download-artifact@v3 - with: - name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }} - path: ${{ env.SKETCHES_REPORTS_PATH }} - - - name: Report results - uses: P-R-O-C-H-Y/report-size-deltas@main - with: - sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }} - destination-file: ${{ env.RESULT_LIBRARY_TEST_FILE }} - - - name: Append file with action URL - run: - echo "/ [GitHub Action Link](https://github.com/${{github.repository}}/actions/runs/${{github.run_id}})" >> ${{ env.RESULT_LIBRARY_TEST_FILE }} - - - name: Push to github repo - run: | - git config user.name github-actions - git config user.email github-actions@github.com - git add ${{ env.RESULT_LIBRARY_TEST_FILE }} - git commit -m "Generated External Libraries Test Results" - git push origin HEAD:gh-pages - - event_file: - name: "Event File" - if: | - contains(github.event.pull_request.labels.*.name, 'lib_test') - needs: compile-sketch - runs-on: ubuntu-latest - steps: - - name: Upload - uses: actions/upload-artifact@v2 - with: - name: Event File - path: ${{github.event_path}} \ No newline at end of file diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index 34d3564c4a8..00000000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Unit Test Results - -on: - workflow_run: - workflows: [Run tests in hardware] - branches-ignore: [master] - - types: - - completed - -jobs: - unit-test-results: - name: Unit Test Results - runs-on: ubuntu-latest - if: | - github.event.workflow_run.event == 'pull_request' && - (github.event.workflow_run.conclusion == 'success' || - github.event.workflow_run.conclusion == 'failure') - steps: - - name: Download and Extract Artifacts - env: - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - run: | - mkdir -p artifacts && cd artifacts - artifacts_url=${{ github.event.workflow_run.artifacts_url }} - gh api "$artifacts_url" -q '.artifacts[] | [.name, .archive_download_url] | @tsv' | while read artifact - do - IFS=$'\t' read name url <<< "$artifact" - gh api $url > "$name.zip" - unzip -d "$name" "$name.zip" - done - - name: Publish Unit Test Results - uses: EnricoMi/publish-unit-test-result-action@v1 - with: - commit: ${{ github.event.workflow_run.head_sha }} - event_file: artifacts/Event File/event.json - event_name: ${{ github.event.workflow_run.event }} - files: "artifacts/**/*.xml" diff --git a/.github/workflows/publishlib.yml b/.github/workflows/publishlib.yml deleted file mode 100644 index e4c75aefe34..00000000000 --- a/.github/workflows/publishlib.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: External Libraries Results - -on: - workflow_run: - workflows: [External Libraries Test] - types: - - completed - - workflow_dispatch: -env: - # It's convenient to set variables for values used multiple times in the workflow - SKETCHES_REPORTS_PATH: artifacts/libraries-report - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - PR_EVENT_PATH: artifacts/Event File/event.json - -jobs: - lib-test-results: - name: External Libraries Test Results - runs-on: ubuntu-latest - if: | - github.event.workflow_run.event == 'pull_request' && - github.event.workflow_run.conclusion == 'success' - - steps: - - name: Download and Extract Artifacts - run: | - mkdir -p artifacts && cd artifacts - artifacts_url=${{ github.event.workflow_run.artifacts_url }} - gh api "$artifacts_url" -q '.artifacts[] | [.name, .archive_download_url] | @tsv' | while read artifact - do - IFS=$'\t' read name url <<< "$artifact" - gh api $url > "$name.zip" - unzip -d "$name" "$name.zip" - done - - - name: Report results - uses: P-R-O-C-H-Y/report-size-deltas@main - with: - sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }} - github-token: ${{ env.GITHUB_TOKEN }} - pr-event-path: ${{ env.PR_EVENT_PATH }} diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml deleted file mode 100644 index 9a0561c92cd..00000000000 --- a/.github/workflows/push.yml +++ /dev/null @@ -1,112 +0,0 @@ -name: ESP32 Arduino CI - -on: - workflow_dispatch: - push: - branches: - - master - - release/* - pull_request: - -concurrency: - group: build-${{github.event.pull_request.number || github.ref}} - cancel-in-progress: true - -jobs: - - cmake-check: - name: Check cmake file - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - run: bash ./.github/scripts/check-cmakelists.sh - - # Ubuntu - build-arduino-linux: - name: Arduino ${{ matrix.chunk }} on ubuntu-latest - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - chunk: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14] - - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - name: Cache tools - id: cache-linux - uses: actions/cache@v3 - with: - path: | - ./tools/dist - ~/arduino_ide - key: ${{ runner.os }}-${{ hashFiles('package/package_esp32_index.template.json', - 'tools/get.py', - '.github/scripts/install-arduino-ide.sh') }} - - name: Build Sketches - run: bash ./.github/scripts/on-push.sh ${{ matrix.chunk }} 15 - - # Windows and MacOS - build-arduino-win-mac: - name: Arduino on ${{ matrix.os }} - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - matrix: - os: [windows-latest, macOS-latest] - - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - name: Build Sketches - run: bash ./.github/scripts/on-push.sh - - # PlatformIO on Windows, Ubuntu and Mac - build-platformio: - name: PlatformIO on ${{ matrix.os }} - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - matrix: - os: [ubuntu-latest, windows-latest, macOS-latest] - - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - name: Build Sketches - run: bash ./.github/scripts/on-push.sh 1 1 #equal and non-zero to trigger PIO - - build-esp-idf-component: - name: Build with ESP-IDF ${{ matrix.idf_ver }} for ${{ matrix.idf_target }} - runs-on: ubuntu-20.04 - strategy: - fail-fast: false - matrix: - # The version names here correspond to the versions of espressif/idf Docker image. - # See https://hub.docker.com/r/espressif/idf/tags and - # https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-docker-image.html - # for details. - idf_ver: ["release-v5.1"] - idf_target: ["esp32", "esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2"] - container: espressif/idf:${{ matrix.idf_ver }} - steps: - - name: Check out arduino-esp32 as a component - uses: actions/checkout@v3 - with: - submodules: recursive - path: components/arduino-esp32 - - name: Build - env: - IDF_TARGET: ${{ matrix.idf_target }} - shell: bash - run: | - . ${IDF_PATH}/export.sh - idf.py create-project test - echo CONFIG_FREERTOS_HZ=1000 > test/sdkconfig.defaults - idf.py -C test -DEXTRA_COMPONENT_DIRS=$PWD/components build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index c5555027bf0..00000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: ESP32 Arduino Release - -on: - release: - types: published - -jobs: - build: - name: Publish Release - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - name: Build Release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: bash ./.github/scripts/on-release.sh diff --git a/.github/workflows/upload-idf-component.yml b/.github/workflows/upload-idf-component.yml deleted file mode 100644 index 8fcebf00204..00000000000 --- a/.github/workflows/upload-idf-component.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Push components to https://components.espressif.com -on: - push: - tags: - - '*' -jobs: - upload_components: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - submodules: "recursive" - - - name: Upload components to the component registry - uses: espressif/upload-components-ci-action@v1 - with: - name: arduino-esp32 - version: ${{ github.ref_name }} - namespace: espressif - api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} From 6d960fe5c9add14b76f2800369f77d751d8cea15 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:05:07 +0000 Subject: [PATCH 04/24] Added back the deploy on PR - Clean CI 2 --- .github/workflows/docs_deploy.yml | 46 ------------- .github/workflows/docs_preview copy.yml | 89 ------------------------- 2 files changed, 135 deletions(-) delete mode 100644 .github/workflows/docs_deploy.yml delete mode 100644 .github/workflows/docs_preview copy.yml diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml deleted file mode 100644 index ebc8acac792..00000000000 --- a/.github/workflows/docs_deploy.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Documentation Build and Deploy Production CI - -on: - push: - branches: - - release/* - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - -jobs: - - deploy-prod-docs: - name: Deploy Documentation Production - 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: "${CI_PROJECT_DIR}/docs/_build/" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} - 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 diff --git a/.github/workflows/docs_preview copy.yml b/.github/workflows/docs_preview copy.yml deleted file mode 100644 index 10381d4cee1..00000000000 --- a/.github/workflows/docs_preview copy.yml +++ /dev/null @@ -1,89 +0,0 @@ -name: Documentation Build and Deploy CI - -on: - push: - branches: - - master - - release/* - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - -jobs: - - build-docs: - name: Build ESP-Docs - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs - - deploy-preview-docs: - name: Deploy Documentation - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - 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 - TYPE: "preview" - # DOCS_BUILD_DIR: "./docs/_build" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - 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..." - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ - cd $GITHUB_WORKSPACE/docs - deploy-docs From be1c7d9442755d52256ab6bf3826131c6142c454 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:08:08 +0000 Subject: [PATCH 05/24] Added back the deploy on PR - Clean CI 3 --- .github/workflows/docs.yml | 5 +++-- .github/workflows/docs_build.yml | 37 -------------------------------- 2 files changed, 3 insertions(+), 39 deletions(-) delete mode 100644 .github/workflows/docs_build.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 10381d4cee1..48176e62e2a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -50,10 +50,10 @@ jobs: run: shell: bash steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v2 with: submodules: true - - uses: actions/setup-python@v4 + - uses: actions/setup-python@v2 with: python-version: '3.10' - name: Deploy Preview @@ -87,3 +87,4 @@ jobs: export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ cd $GITHUB_WORKSPACE/docs deploy-docs + \ No newline at end of file diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml deleted file mode 100644 index c18120c079f..00000000000 --- a/.github/workflows/docs_build.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: Documentation Build and Deploy CI - -on: - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - -jobs: - - build-docs: - name: Build Documentation - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs From c50a7f973ae6643caffbc51f452c334565139f10 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:24:04 +0000 Subject: [PATCH 06/24] Added back the deploy on PR - Clean CI 4 --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 97b552574b9..1fd270a3dcf 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 -sphinx-tabs==3.2.0 \ No newline at end of file +sphinx-tabs==3.2.0 +sphinxcontrib-applehelp==1.0.7 \ No newline at end of file From 3c01280f02cf768bee0e9a4fcc8bb6f5726c5efb Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:26:24 +0000 Subject: [PATCH 07/24] Added back the deploy on PR - Clean CI 4 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 1fd270a3dcf..d487fa511b0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 sphinx-tabs==3.2.0 -sphinxcontrib-applehelp==1.0.7 \ No newline at end of file +sphinxcontrib-applehelp==1.0.6 \ No newline at end of file From fa87fbcbd95162b053e8f53d3046de035dd9edbc Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:27:37 +0000 Subject: [PATCH 08/24] Added back the deploy on PR - Clean CI 4 --- docs/requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d487fa511b0..97b552574b9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,3 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 -sphinx-tabs==3.2.0 -sphinxcontrib-applehelp==1.0.6 \ No newline at end of file +sphinx-tabs==3.2.0 \ No newline at end of file From 3dd2994662a496799df187f110565fa960bb2bb6 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:29:01 +0000 Subject: [PATCH 09/24] Added back the deploy on PR - Clean CI 4 --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 97b552574b9..14a83f7d7ac 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 -sphinx-tabs==3.2.0 \ No newline at end of file +sphinx-tabs==3.2.0 +sphinxcontrib-applehelp==1.0.4 \ No newline at end of file From 22029afb004a97316a9cf04b34729af395dfe652 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:32:14 +0000 Subject: [PATCH 10/24] Added back the deploy on PR - Clean CI 5 --- docs/requirements.txt | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 14a83f7d7ac..7c819ff0836 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,15 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 sphinx-tabs==3.2.0 -sphinxcontrib-applehelp==1.0.4 \ No newline at end of file +sphinxcontrib-actdiag==3.0.0 +sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-blockdiag==3.0.0 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-nwdiag==2.0.0 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-seqdiag==3.0.0 +sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-svg2pdfconverter==1.2.0 +sphinxcontrib-wavedrom==3.0.4 From a88a9c9437a2f6f45fcc505ded2d9dd8f0440e2c Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:36:54 +0000 Subject: [PATCH 11/24] Added back the deploy on PR - Clean CI 6 --- .github/workflows/docs_deploy_preview.yml | 61 +++++++++++++++++++++++ .github/workflows/docs_deploy_prod.yml | 61 +++++++++++++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 .github/workflows/docs_deploy_preview.yml create mode 100644 .github/workflows/docs_deploy_prod.yml diff --git a/.github/workflows/docs_deploy_preview.yml b/.github/workflows/docs_deploy_preview.yml new file mode 100644 index 00000000000..44943edadf9 --- /dev/null +++ b/.github/workflows/docs_deploy_preview.yml @@ -0,0 +1,61 @@ +name: Documentation Build and Deploy CI + +on: + push: + branches: + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.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 + TYPE: "preview" + # DOCS_BUILD_DIR: "./docs/_build" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + 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..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs + deploy-docs + \ No newline at end of file diff --git a/.github/workflows/docs_deploy_prod.yml b/.github/workflows/docs_deploy_prod.yml new file mode 100644 index 00000000000..9500b668d84 --- /dev/null +++ b/.github/workflows/docs_deploy_prod.yml @@ -0,0 +1,61 @@ +name: Documentation Build and Deploy CI + +on: + push: + branches: + - master + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.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 + TYPE: "preview" + # DOCS_BUILD_DIR: "./docs/_build" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + 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..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs + deploy-docs + \ No newline at end of file From 98e71f7ca1449db91b55913f3019dc1d5b181e42 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:43:47 +0000 Subject: [PATCH 12/24] Added back the deploy on PR - Clean CI 7 --- .github/workflows/docs_deploy_preview.yml | 2 +- .github/workflows/docs_deploy_prod.yml | 30 ++++++++++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_deploy_preview.yml b/.github/workflows/docs_deploy_preview.yml index 44943edadf9..37bf2b53950 100644 --- a/.github/workflows/docs_deploy_preview.yml +++ b/.github/workflows/docs_deploy_preview.yml @@ -1,4 +1,4 @@ -name: Documentation Build and Deploy CI +name: Documentation Preview Build and Deploy CI on: push: diff --git a/.github/workflows/docs_deploy_prod.yml b/.github/workflows/docs_deploy_prod.yml index 9500b668d84..d3380fce6f3 100644 --- a/.github/workflows/docs_deploy_prod.yml +++ b/.github/workflows/docs_deploy_prod.yml @@ -1,4 +1,4 @@ -name: Documentation Build and Deploy CI +name: Documentation Production Build and Deploy CI on: push: @@ -14,6 +14,34 @@ on: jobs: + build-docs: + name: Build ESP-Docs + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Build + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + cd ./docs + PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary + PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en + - name: Archive Docs + uses: actions/upload-artifact@v2 + with: + name: docs + path: docs + deploy-preview-docs: name: Deploy Documentation runs-on: ubuntu-22.04 From 2f501f963a31c8da8db93a2ef4c17db7ef15c872 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:49:26 +0000 Subject: [PATCH 13/24] Added back the deploy on PR - Clean CI 8 --- .github/workflows/docs_deploy_preview.yml | 34 +++++++++++++++++++++-- .github/workflows/docs_deploy_prod.yml | 4 +-- 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs_deploy_preview.yml b/.github/workflows/docs_deploy_preview.yml index 37bf2b53950..1b43951241e 100644 --- a/.github/workflows/docs_deploy_preview.yml +++ b/.github/workflows/docs_deploy_preview.yml @@ -14,17 +14,45 @@ on: jobs: + build-docs: + name: Build Production ESP-Docs + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Build + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + cd ./docs + PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary + PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en + - name: Archive Docs + uses: actions/upload-artifact@v2 + with: + name: docs + path: docs + deploy-preview-docs: - name: Deploy Documentation + name: Deploy Preview Documentation runs-on: ubuntu-22.04 defaults: run: shell: bash steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: submodules: true - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4 with: python-version: '3.10' - name: Deploy Preview diff --git a/.github/workflows/docs_deploy_prod.yml b/.github/workflows/docs_deploy_prod.yml index d3380fce6f3..92139946b16 100644 --- a/.github/workflows/docs_deploy_prod.yml +++ b/.github/workflows/docs_deploy_prod.yml @@ -15,7 +15,7 @@ on: jobs: build-docs: - name: Build ESP-Docs + name: Build Production ESP-Docs runs-on: ubuntu-22.04 defaults: run: @@ -43,7 +43,7 @@ jobs: path: docs deploy-preview-docs: - name: Deploy Documentation + name: Deploy Production Documentation runs-on: ubuntu-22.04 defaults: run: From 986cae2e35d0dde52bdb0931e6989d81c4ce32dd Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 09:55:02 +0000 Subject: [PATCH 14/24] Added back the deploy on PR - Clean CI 9 --- .github/workflows/docs.yml | 33 +-------- .github/workflows/docs_build.yml | 45 ++++++++++++ .github/workflows/docs_deploy_preview.yml | 89 ----------------------- .github/workflows/docs_deploy_prod.yml | 89 ----------------------- 4 files changed, 47 insertions(+), 209 deletions(-) create mode 100644 .github/workflows/docs_build.yml delete mode 100644 .github/workflows/docs_deploy_preview.yml delete mode 100644 .github/workflows/docs_deploy_prod.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 48176e62e2a..9f0206d2f35 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,34 +15,6 @@ on: jobs: - build-docs: - name: Build ESP-Docs - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs - deploy-preview-docs: name: Deploy Documentation runs-on: ubuntu-22.04 @@ -50,10 +22,10 @@ jobs: run: shell: bash steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: submodules: true - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4 with: python-version: '3.10' - name: Deploy Preview @@ -87,4 +59,3 @@ jobs: export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ cd $GITHUB_WORKSPACE/docs deploy-docs - \ No newline at end of file diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml new file mode 100644 index 00000000000..0167a19a032 --- /dev/null +++ b/.github/workflows/docs_build.yml @@ -0,0 +1,45 @@ +name: Documentation Build and Deploy CI + +on: + push: + branches: + - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + +jobs: + + build-docs: + name: Build ESP-Docs + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Build + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + cd ./docs + PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary + PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en + - name: Archive Docs + uses: actions/upload-artifact@v2 + with: + name: docs + path: docs + \ No newline at end of file diff --git a/.github/workflows/docs_deploy_preview.yml b/.github/workflows/docs_deploy_preview.yml deleted file mode 100644 index 1b43951241e..00000000000 --- a/.github/workflows/docs_deploy_preview.yml +++ /dev/null @@ -1,89 +0,0 @@ -name: Documentation Preview Build and Deploy CI - -on: - push: - branches: - - release/* - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - -jobs: - - build-docs: - name: Build Production ESP-Docs - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs - - deploy-preview-docs: - name: Deploy Preview Documentation - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - 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 - TYPE: "preview" - # DOCS_BUILD_DIR: "./docs/_build" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - 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..." - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ - cd $GITHUB_WORKSPACE/docs - deploy-docs - \ No newline at end of file diff --git a/.github/workflows/docs_deploy_prod.yml b/.github/workflows/docs_deploy_prod.yml deleted file mode 100644 index 92139946b16..00000000000 --- a/.github/workflows/docs_deploy_prod.yml +++ /dev/null @@ -1,89 +0,0 @@ -name: Documentation Production Build and Deploy CI - -on: - push: - branches: - - master - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' - -jobs: - - build-docs: - name: Build Production ESP-Docs - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs - - deploy-preview-docs: - name: Deploy Production 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 - TYPE: "preview" - # DOCS_BUILD_DIR: "./docs/_build" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - 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..." - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ - cd $GITHUB_WORKSPACE/docs - deploy-docs - \ No newline at end of file From 5501ac66e0d1a27362a296d6dda4b752efe5ade2 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 12:06:25 +0000 Subject: [PATCH 15/24] Added back the deploy on PR - Clean CI 10 --- .github/workflows/docs.yml | 10 +++--- .github/workflows/docs_deploy.yml | 54 +++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/docs_deploy.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9f0206d2f35..a1b06c439e7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,19 +32,19 @@ jobs: env: # Deploy to production server # DOCS_BUILD_DIR: "./docs/_build/" - # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }} + # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} + # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} # 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 }} + # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} + # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} # Deploy to preview server TYPE: "preview" # DOCS_BUILD_DIR: "./docs/_build" DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} run: | sudo apt update sudo apt install python3-pip python3-setuptools diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml new file mode 100644 index 00000000000..de2add37759 --- /dev/null +++ b/.github/workflows/docs_deploy.yml @@ -0,0 +1,54 @@ +name: Documentation Build and Deploy CI + +on: + push: + branches: + - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + +jobs: + + deploy-preview-docs: + name: Deploy Documentation + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Deploy Preview + env: + # Deploy to production server + # DOCS_BUILD_DIR: "./docs/_build/" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} + # Deploy to preview server + 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..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs + deploy-docs From fd2eb815606b216ba168f45b55b0170c720b1ac8 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 12:11:32 +0000 Subject: [PATCH 16/24] Added back the deploy on PR - Clean CI 11 --- .github/workflows/docs_deploy.yml | 8 ++++---- .github/workflows/{docs.yml => docs_preview.yml} | 16 ++++------------ 2 files changed, 8 insertions(+), 16 deletions(-) rename .github/workflows/{docs.yml => docs_preview.yml} (74%) diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml index de2add37759..5796e7f1fa6 100644 --- a/.github/workflows/docs_deploy.yml +++ b/.github/workflows/docs_deploy.yml @@ -1,4 +1,4 @@ -name: Documentation Build and Deploy CI +name: Documentation Build and Production Deploy CI on: push: @@ -15,8 +15,8 @@ on: jobs: - deploy-preview-docs: - name: Deploy Documentation + deploy-prod-docs: + name: Deploy Documentation on Production runs-on: ubuntu-22.04 defaults: run: @@ -28,7 +28,7 @@ jobs: - uses: actions/setup-python@v4 with: python-version: '3.10' - - name: Deploy Preview + - name: Deploy Documentation env: # Deploy to production server # DOCS_BUILD_DIR: "./docs/_build/" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs_preview.yml similarity index 74% rename from .github/workflows/docs.yml rename to .github/workflows/docs_preview.yml index a1b06c439e7..a2abb7f9833 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs_preview.yml @@ -8,10 +8,10 @@ on: paths: - 'docs/**' - '.github/workflows/docs.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' + # pull_request: + # paths: + # - 'docs/**' + # - '.github/workflows/docs.yml' jobs: @@ -30,15 +30,7 @@ jobs: python-version: '3.10' - name: Deploy Preview env: - # Deploy to production server - # DOCS_BUILD_DIR: "./docs/_build/" - # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} - # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} - # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} - # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} # Deploy to preview server - TYPE: "preview" # DOCS_BUILD_DIR: "./docs/_build" DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} From 85c8163f3aea72e9b68761a8feddb32346b5cc58 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Mon, 15 Jan 2024 12:58:14 +0000 Subject: [PATCH 17/24] Added back the deploy on PR - Clean CI 12 --- .github/workflows/docs_deploy.yml | 5 ----- .github/workflows/docs_preview.yml | 5 ----- 2 files changed, 10 deletions(-) diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml index 5796e7f1fa6..7a1123454ae 100644 --- a/.github/workflows/docs_deploy.yml +++ b/.github/workflows/docs_deploy.yml @@ -3,15 +3,10 @@ name: Documentation Build and Production Deploy CI on: push: branches: - - master - release/* paths: - 'docs/**' - '.github/workflows/docs.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs.yml' jobs: diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index a2abb7f9833..f1c474f8ab0 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -4,14 +4,9 @@ on: push: branches: - master - - release/* paths: - 'docs/**' - '.github/workflows/docs.yml' - # pull_request: - # paths: - # - 'docs/**' - # - '.github/workflows/docs.yml' jobs: From 563ccce8ea39cfbc52d6a81ea785b39403ab0c24 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 12:56:34 +0000 Subject: [PATCH 18/24] Added back the deploy on PR - Clean CI 13 --- .github/workflows/docs_preview.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 3923839ada0..202dd8118d7 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -27,11 +27,17 @@ jobs: env: # Deploy to preview server # DOCS_BUILD_DIR: "./docs/_build" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} + + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} run: | sudo apt update sudo apt install python3-pip python3-setuptools From 334f04d1254839b475352e450fc8d5a01c990af7 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:02:06 +0000 Subject: [PATCH 19/24] Added back the deploy on PR - Clean CI 14 --- .github/workflows/docs_preview.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 202dd8118d7..84e074f601c 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -7,6 +7,10 @@ on: paths: - 'docs/**' - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' jobs: From af2d217e32376bb81261015bdabb193a751d9de6 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:30:23 +0000 Subject: [PATCH 20/24] Added back the deploy on PR - Clean CI 15 --- .github/workflows/docs_build.yml | 4 ++-- .github/workflows/docs_deploy.yml | 2 +- .github/workflows/docs_preview.yml | 6 +++++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml index d20a6421d99..2009425a33e 100644 --- a/.github/workflows/docs_build.yml +++ b/.github/workflows/docs_build.yml @@ -7,11 +7,11 @@ on: - release/* paths: - 'docs/**' - - '.github/workflows/docs.yml' + - '.github/workflows/docs_build.yml' pull_request: paths: - 'docs/**' - - '.github/workflows/docs.yml' + - '.github/workflows/docs_build.yml' jobs: diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml index 7a1123454ae..15ea02ed5b8 100644 --- a/.github/workflows/docs_deploy.yml +++ b/.github/workflows/docs_deploy.yml @@ -6,7 +6,7 @@ on: - release/* paths: - 'docs/**' - - '.github/workflows/docs.yml' + - '.github/workflows/docs_deploy.yml' jobs: diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 417ea7d5d10..ee8247624c1 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -6,7 +6,11 @@ on: - master paths: - 'docs/**' - - '.github/workflows/docs.yml' + - '.github/workflows/docs_preview.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs_preview.yml' jobs: From f44aafe821ac9054d569a0f7445f2fdb583e0a23 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:34:04 +0000 Subject: [PATCH 21/24] Added back the deploy on PR - Clean CI 16 --- .github/workflows/docs_preview.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index ee8247624c1..d24019a20f8 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -7,10 +7,10 @@ on: paths: - 'docs/**' - '.github/workflows/docs_preview.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs_preview.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs_preview.yml' jobs: From 5965b4b6deee7466dc9bcfc0d97eb2c5b140c047 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:36:12 +0000 Subject: [PATCH 22/24] Added back the deploy on PR - Clean CI 17 --- .github/workflows/docs_build.yml | 39 ++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml index 2009425a33e..eaec03c2a95 100644 --- a/.github/workflows/docs_build.yml +++ b/.github/workflows/docs_build.yml @@ -42,3 +42,42 @@ jobs: with: name: docs path: docs + + deploy-prod-docs: + name: Deploy Documentation on Production + runs-on: ubuntu-22.04 + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Deploy Documentation + env: + # Deploy to production server + # DOCS_BUILD_DIR: "./docs/_build/" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} + # Deploy to preview server + 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..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs + deploy-docs + \ No newline at end of file From a93c98fcfcb7f5a704a6fecee687b6eb62da8755 Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:38:46 +0000 Subject: [PATCH 23/24] Added back the deploy on PR - Clean CI 18 --- .github/workflows/docs_deploy.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml index 15ea02ed5b8..7f5251ce75a 100644 --- a/.github/workflows/docs_deploy.yml +++ b/.github/workflows/docs_deploy.yml @@ -27,11 +27,11 @@ jobs: env: # Deploy to production server # DOCS_BUILD_DIR: "./docs/_build/" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} # Deploy to preview server run: | sudo apt update From fc87f26f504bd70442fe88805935b3889be7f9ae Mon Sep 17 00:00:00 2001 From: pedrominatel Date: Tue, 16 Jan 2024 13:43:16 +0000 Subject: [PATCH 24/24] Added back the deploy on PR - Clean CI 19 --- .github/workflows/docs_build.yml | 48 +++++-------------------- .github/workflows/docs_deploy.yml | 49 ------------------------- .github/workflows/docs_preview.yml | 58 ------------------------------ 3 files changed, 9 insertions(+), 146 deletions(-) delete mode 100644 .github/workflows/docs_deploy.yml delete mode 100644 .github/workflows/docs_preview.yml diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml index eaec03c2a95..aebde2257ba 100644 --- a/.github/workflows/docs_build.yml +++ b/.github/workflows/docs_build.yml @@ -15,8 +15,8 @@ on: jobs: - build-docs: - name: Build ESP-Docs + deploy-preview-docs: + name: Deploy Documentation runs-on: ubuntu-22.04 defaults: run: @@ -28,44 +28,15 @@ jobs: - uses: actions/setup-python@v4 with: python-version: '3.10' - - name: Build - run: | - sudo apt update - sudo apt install python3-pip python3-setuptools - # GitHub CI installs pip3 and setuptools outside the path. - # Update the path to include them and run. - cd ./docs - PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary - PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en - - name: Archive Docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: docs - - deploy-prod-docs: - name: Deploy Documentation on Production - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Deploy Documentation + - name: Deploy Preview env: - # Deploy to production server - # DOCS_BUILD_DIR: "./docs/_build/" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} # Deploy to preview server + # DOCS_BUILD_DIR: "./docs/_build" + DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} + DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} + DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} run: | sudo apt update sudo apt install python3-pip python3-setuptools @@ -80,4 +51,3 @@ jobs: export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ cd $GITHUB_WORKSPACE/docs deploy-docs - \ No newline at end of file diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml deleted file mode 100644 index 7f5251ce75a..00000000000 --- a/.github/workflows/docs_deploy.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: Documentation Build and Production Deploy CI - -on: - push: - branches: - - release/* - paths: - - 'docs/**' - - '.github/workflows/docs_deploy.yml' - -jobs: - - deploy-prod-docs: - name: Deploy Documentation on Production - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Deploy Documentation - env: - # Deploy to production server - # DOCS_BUILD_DIR: "./docs/_build/" - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} - # Deploy to preview server - 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..." - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ - cd $GITHUB_WORKSPACE/docs - deploy-docs diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml deleted file mode 100644 index d24019a20f8..00000000000 --- a/.github/workflows/docs_preview.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: Documentation Build and Preview Deploy CI - -on: - push: - branches: - - master - paths: - - 'docs/**' - - '.github/workflows/docs_preview.yml' - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs_preview.yml' - -jobs: - - deploy-preview-docs: - name: Deploy Documentation - runs-on: ubuntu-22.04 - defaults: - run: - shell: bash - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Deploy Preview - env: - # Deploy to preview server - # DOCS_BUILD_DIR: "./docs/_build" - # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} - # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} - # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} - # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} - // Production - DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} - DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} - 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..." - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ - cd $GITHUB_WORKSPACE/docs - deploy-docs