Skip to content

Deploy docs on preview server #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d42a35b
Added back the deploy on PR
pedrominatel Jan 15, 2024
75fdc6a
Added back the deploy on PR
pedrominatel Jan 15, 2024
61a0a8f
Added back the deploy on PR - Clean CI
pedrominatel Jan 15, 2024
6d960fe
Added back the deploy on PR - Clean CI 2
pedrominatel Jan 15, 2024
be1c7d9
Added back the deploy on PR - Clean CI 3
pedrominatel Jan 15, 2024
c50a7f9
Added back the deploy on PR - Clean CI 4
pedrominatel Jan 15, 2024
3c01280
Added back the deploy on PR - Clean CI 4
pedrominatel Jan 15, 2024
fa87fbc
Added back the deploy on PR - Clean CI 4
pedrominatel Jan 15, 2024
3dd2994
Added back the deploy on PR - Clean CI 4
pedrominatel Jan 15, 2024
22029af
Added back the deploy on PR - Clean CI 5
pedrominatel Jan 15, 2024
a88a9c9
Added back the deploy on PR - Clean CI 6
pedrominatel Jan 15, 2024
98e71f7
Added back the deploy on PR - Clean CI 7
pedrominatel Jan 15, 2024
2f501f9
Added back the deploy on PR - Clean CI 8
pedrominatel Jan 15, 2024
986cae2
Added back the deploy on PR - Clean CI 9
pedrominatel Jan 15, 2024
5501ac6
Added back the deploy on PR - Clean CI 10
pedrominatel Jan 15, 2024
fd2eb81
Added back the deploy on PR - Clean CI 11
pedrominatel Jan 15, 2024
85c8163
Added back the deploy on PR - Clean CI 12
pedrominatel Jan 15, 2024
563ccce
Added back the deploy on PR - Clean CI 13
pedrominatel Jan 16, 2024
898e548
Merge branch 'master' into docs_migration_deploy
pedrominatel Jan 16, 2024
334f04d
Added back the deploy on PR - Clean CI 14
pedrominatel Jan 16, 2024
af2d217
Added back the deploy on PR - Clean CI 15
pedrominatel Jan 16, 2024
6910270
Merge branch 'master' into docs_migration_deploy
pedrominatel Jan 16, 2024
f44aafe
Added back the deploy on PR - Clean CI 16
pedrominatel Jan 16, 2024
5965b4b
Added back the deploy on PR - Clean CI 17
pedrominatel Jan 16, 2024
a93c98f
Added back the deploy on PR - Clean CI 18
pedrominatel Jan 16, 2024
fc87f26
Added back the deploy on PR - Clean CI 19
pedrominatel Jan 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 0 additions & 92 deletions .github/workflows/allboards.yml

This file was deleted.

71 changes: 0 additions & 71 deletions .github/workflows/boards.yml

This file was deleted.

141 changes: 0 additions & 141 deletions .github/workflows/build_py_tools.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/dangerjs.yml

This file was deleted.

40 changes: 24 additions & 16 deletions .github/workflows/docs_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ 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:

build-docs:
name: Build ESP-Docs
deploy-preview-docs:
name: Deploy Documentation
runs-on: ubuntu-22.04
defaults:
run:
Expand All @@ -28,18 +28,26 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Build
- 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 }}
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

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
Loading