mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
2494342d4c
* Update controller_doc_classes.py * test gh-actions * Update gh-pages.yml * Update generate_terminal_markdown.py * cleanup generate_terminal_markdown.py, patch binance error preventing generation Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com>
77 lines
2.4 KiB
YAML
Vendored
77 lines
2.4 KiB
YAML
Vendored
name: Deploy to GitHub Pages
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
generate:
|
|
name: Generate and Deploy documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Git checkout
|
|
uses: actions/checkout@v3 # actions/checkout v3.0.2
|
|
|
|
- name: Setup Python 3.9
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.9"
|
|
architecture: x64
|
|
|
|
- name: Install Poetry
|
|
uses: snok/install-poetry@v1
|
|
with:
|
|
version: 1.1.13
|
|
virtualenvs-create: true
|
|
virtualenvs-in-project: true
|
|
|
|
- name: Load cached venv
|
|
id: cached-poetry-dependencies
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: .venv
|
|
key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock') }}
|
|
|
|
- name: Install dependencies
|
|
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
|
|
run: poetry install --no-interaction --no-root -E doc
|
|
|
|
- name: Install packages
|
|
run: poetry install --no-interaction -E prediction -E doc -E optimization
|
|
|
|
- run: |
|
|
source $VENV
|
|
pytest tests/website --autodoc
|
|
python website/generate_sdk_markdown.py && python website/generate_terminal_markdown.py
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: 18
|
|
cache: yarn
|
|
cache-dependency-path: website/yarn.lock
|
|
|
|
- name: Install dependencies
|
|
run: yarn install --frozen-lockfile
|
|
working-directory: website
|
|
|
|
- name: Build website
|
|
run: yarn build
|
|
working-directory: website
|
|
|
|
# Popular action to deploy to GitHub Pages:
|
|
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
|
- name: Deploy to GitHub Pages
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.DEPLOY_TOKEN }}
|
|
publish_dir: ./website/build
|
|
# The following lines assign commit authorship to the official
|
|
# GH-Actions bot for deploys to `gh-pages` branch:
|
|
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
|
|
# The GH actions bot is used by default if you didn't specify the two fields.
|
|
# You can swap them out with your own user credentials.
|
|
user_name: github-actions[bot]
|
|
user_email: 41898282+github-actions[bot]@users.noreply.github.com
|