forked from espressif/esp-protocols
78 lines
2.4 KiB
YAML
78 lines
2.4 KiB
YAML
name: Docs and Publish New
|
|
|
|
on:
|
|
push:
|
|
|
|
env:
|
|
DOCS_DEPLOY_URL_BASE: "${{ secrets.DOCS_PREVIEW_SERVER_URL }}"
|
|
#DOCS_DEPLOY_SERVER: "ci.espressif.cn:42348"
|
|
DOCS_DEPLOY_SERVER: "ci.espressif.cn:42348"
|
|
DOCS_DEPLOY_SERVER_USER: "${{ secrets.DOCS_SERVER_USER }}"
|
|
DOCS_DEPLOY_PRIVATEKEY : "${{ secrets.DOCS_DEPLOY_KEY }}"
|
|
DOCS_DEPLOY_KEY: "${{ secrets.DOCS_DEPLOY_KEY }}"
|
|
DOCS_DEPLOY_PATH : "${{ secrets.DOCS_PATH }}"
|
|
|
|
jobs:
|
|
docs_build:
|
|
name: Docs-Build-And-Upload
|
|
runs-on: ubuntu-latest
|
|
# Skip running on forks since it won't have access to secrets
|
|
#if: github.repository == 'espressif/esp-protocols'
|
|
steps:
|
|
- name: Checkout esp-protocols
|
|
uses: actions/checkout@master
|
|
with:
|
|
persist-credentials: false
|
|
fetch-depth: 0
|
|
submodules: recursive
|
|
- name: Generate and delploying docs
|
|
shell: bash
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get -y install doxygen clang python3-pip
|
|
python -m pip install breathe recommonmark esp-docs
|
|
cd $GITHUB_WORKSPACE/components/esp_websocket_client/docs
|
|
./generate_docs
|
|
source $GITHUB_WORKSPACE/docs/utils.sh
|
|
add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
|
|
export GIT_VER=$(git describe --always)
|
|
ls -l $GITHUB_WORKSPACE/components/esp_websocket_client/docs
|
|
export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/components/esp_websocket_client/docs
|
|
deploy-docs
|
|
|
|
#build_docs:
|
|
# stage: build
|
|
# image: $ESP_DOCS_ENV_IMAGE
|
|
# tags:
|
|
# - build_docs
|
|
# artifacts:
|
|
# when: always
|
|
# paths:
|
|
# - docs/_build/*/*/*.txt
|
|
# - docs/_build/*/*/html/*
|
|
# expire_in: 4 days
|
|
# # No cleaning when the artifacts
|
|
# after_script: []
|
|
# script:
|
|
# - cd docs
|
|
# - pip install -r requirements.txt
|
|
# - build-docs -l en -t esp32
|
|
#
|
|
#.deploy_docs_template:
|
|
# stage: deploy
|
|
# image: $ESP_DOCS_ENV_IMAGE
|
|
# tags:
|
|
# - deploy_docs
|
|
# needs:
|
|
# - build_docs
|
|
# only:
|
|
# changes:
|
|
# - "docs/**/*"
|
|
# script:
|
|
# - source ${CI_PROJECT_DIR}/docs/utils.sh
|
|
# - add_doc_server_ssh_keys ${{ secrets.DOCS_DEPLOY_PRIVATEKEY }} ${{ secrets.DOCS_DEPLOY_SERVER }} ${{ secrets.DOCS_DEPLOY_SERVER_USER }}
|
|
# - export GIT_VER=$(git describe --always)
|
|
# - pip install -r ${CI_PROJECT_DIR}/docs/requirements.txt
|
|
# - deploy-docs
|
|
#
|