Merge pull request #1263 from facebookresearch/add-provider-doc-pages #75
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 docs to GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- "docs/web/**" | |
jobs: | |
deploy: | |
name: Deploy docs to GitHub Pages | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: docs/web | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: actions/setup-node@v4 | |
env: | |
FORCE_COLOR: 0 | |
with: | |
node-version: 16.16.0 | |
cache: yarn | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.8 | |
- name: 🤖 Install Mephisto | |
run: | | |
cd ../../ | |
curl -fsS -o get-poetry.py https://install.python-poetry.org | |
python3 get-poetry.py -y | |
echo "$HOME/.poetry/bin" >> $GITHUB_PATH | |
poetry config virtualenvs.create false | |
poetry install | |
- name: 🖋 Create data directory | |
run: mkdir -p ~/mephisto/data | |
- name: 📂 Set the data directory | |
run: mephisto config core.main_data_directory ~/mephisto/data | |
- name: 📝 Auto Generate Blueprint Docs | |
run: | | |
mephisto scripts local_db auto_generate_all_docs_reference_md | |
- name: Install dependencies | |
run: yarn install --frozen-lockfile | |
- name: Build website | |
run: yarn build | |
# 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@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
# Build output to publish to the `gh-pages` branch: | |
publish_dir: ./docs/web/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 |