Skip to content

Commit 29ecacf

Browse files
committed
Fix on the Docs deploy CI
1 parent e4d6a8a commit 29ecacf

File tree

4 files changed

+39
-14
lines changed

4 files changed

+39
-14
lines changed

.github/workflows/docs_build.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
name: Documentation Build and Deploy CI
22

33
on:
4+
push:
5+
branches:
6+
- master
7+
- release/*
8+
paths:
9+
- 'docs/**'
10+
- '.github/workflows/docs.yml'
411
pull_request:
512
paths:
613
- 'docs/**'
@@ -9,7 +16,7 @@ on:
916
jobs:
1017

1118
build-docs:
12-
name: Build Documentation
19+
name: Build ESP-Docs
1320
runs-on: ubuntu-22.04
1421
defaults:
1522
run:
@@ -35,3 +42,4 @@ jobs:
3542
with:
3643
name: docs
3744
path: docs
45+

.github/workflows/docs_deploy.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation Build and Deploy Production CI
1+
name: Documentation Build and Production Deploy CI
22

33
on:
44
push:
@@ -11,27 +11,28 @@ on:
1111
jobs:
1212

1313
deploy-prod-docs:
14-
name: Deploy Documentation Production
14+
name: Deploy Documentation on Production
1515
runs-on: ubuntu-22.04
1616
defaults:
1717
run:
1818
shell: bash
1919
steps:
20-
- uses: actions/checkout@v2
20+
- uses: actions/checkout@v3
2121
with:
2222
submodules: true
23-
- uses: actions/setup-python@v2
23+
- uses: actions/setup-python@v4
2424
with:
2525
python-version: '3.10'
26-
- name: Deploy Preview
26+
- name: Deploy Documentation
2727
env:
2828
# Deploy to production server
29-
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
29+
# DOCS_BUILD_DIR: "./docs/_build/"
3030
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }}
3131
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }}
32-
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }}
33-
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }}
32+
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
3433
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }}
34+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }}
35+
# Deploy to preview server
3536
run: |
3637
sudo apt update
3738
sudo apt install python3-pip python3-setuptools
@@ -43,4 +44,6 @@ jobs:
4344
echo "Building the Docs..."
4445
cd ./docs && build-docs -l en
4546
echo "Deploy the Docs..."
47+
export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
48+
cd $GITHUB_WORKSPACE/docs
4649
deploy-docs

.github/workflows/docs_preview.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation Build and Deploy CI
1+
name: Documentation Build and Preview Deploy CI
22

33
on:
44
push:
@@ -11,7 +11,7 @@ on:
1111
jobs:
1212

1313
deploy-preview-docs:
14-
name: Deploy Documentation Preview
14+
name: Deploy Documentation
1515
runs-on: ubuntu-22.04
1616
defaults:
1717
run:
@@ -26,12 +26,12 @@ jobs:
2626
- name: Deploy Preview
2727
env:
2828
# Deploy to preview server
29-
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
29+
# DOCS_BUILD_DIR: "./docs/_build"
3030
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
3131
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
3232
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
33-
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
3433
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
34+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
3535
run: |
3636
sudo apt update
3737
sudo apt install python3-pip python3-setuptools
@@ -43,4 +43,6 @@ jobs:
4343
echo "Building the Docs..."
4444
cd ./docs && build-docs -l en
4545
echo "Deploy the Docs..."
46+
export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
47+
cd $GITHUB_WORKSPACE/docs
4648
deploy-docs

docs/requirements.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
esp-docs==1.4.*
22
sphinx-copybutton==0.5.0
3-
sphinx-tabs==3.2.0
3+
sphinx-tabs==3.2.0
4+
sphinxcontrib-actdiag==3.0.0
5+
sphinxcontrib-applehelp==1.0.4
6+
sphinxcontrib-blockdiag==3.0.0
7+
sphinxcontrib-devhelp==1.0.2
8+
sphinxcontrib-htmlhelp==2.0.1
9+
sphinxcontrib-jsmath==1.0.1
10+
sphinxcontrib-nwdiag==2.0.0
11+
sphinxcontrib-qthelp==1.0.3
12+
sphinxcontrib-seqdiag==3.0.0
13+
sphinxcontrib-serializinghtml==1.1.5
14+
sphinxcontrib-svg2pdfconverter==1.2.0
15+
sphinxcontrib-wavedrom==3.0.4

0 commit comments

Comments
 (0)