[Docs] Redirect contributing URL (#6460) #80
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 📑 Deploy to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - release/* | |
| - "docs/*" | |
| pull_request: | |
| types: [opened, synchronize, reopened, closed] | |
| branches: | |
| - main | |
| - "docs/*" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| generate: | |
| name: Generate and Deploy documentation | |
| if: > | |
| github.event_name == 'push' || | |
| (github.event_name == 'pull_request' && | |
| startsWith(github.head_ref, 'docs/')) | |
| 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.8.1 | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Setup sudo apt installs for ubuntu-latest | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y \ | |
| libgtk-3-dev \ | |
| libwebkit2gtk-4.0-dev | |
| - name: Generate Platform Markdown | |
| run: | | |
| poetry install -C openbb_platform --no-interaction | |
| source openbb_platform/.venv/bin/activate | |
| pip install -U poetry | |
| pip install toml | |
| python openbb_platform/dev_install.py -e all | |
| python -c "import openbb; openbb.build()" | |
| python website/generate_platform_v4_markdown.py | |
| - name: Generate Excel Docs | |
| run: | | |
| pip install requests | |
| python website/generate_excel_markdown.py | |
| - name: Generate Widgets Library | |
| run: | | |
| pip install requests | |
| python website/generate_widgets_library.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 | |
| 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 | |
| if: > | |
| (startsWith(github.ref, 'refs/heads/main')) || | |
| (github.event_name == 'pull_request' && | |
| github.event.pull_request.merged == true && | |
| github.event.pull_request.base.ref == 'main' && | |
| startsWith(github.head_ref, 'docs/')) | |
| 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 |