Merge pull request #201 from anujdeshpande/patch-1 #167
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
# This action does the following: | |
# 1. Installs pipenv via python-pip | |
# 2. Installs dependencies according to Pipfile | |
# 3. Builds the documentation | |
# 4. Uses scp to copy the build files (html) to remote server | |
name: Build and Deploy Vaaman Documentation | |
on: | |
push: | |
branches: | |
- main | |
- staging | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
# Install dependencies and build the docs | |
- uses: actions/checkout@v4 | |
- name: Setting Up Python Version | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- name: Installing pipenv | |
run: | | |
python3 -m pip install --upgrade pip | |
pip install pipenv | |
- name: Installing Dependencies and Building Docs | |
run: pipenv update && pipenv run make dirhtml -j$(nproc --all) | |
# Copy it to the server | |
- name: Copying build/html/ to remote server | |
uses: appleboy/[email protected] | |
with: | |
host: ${{ secrets.HOST }} | |
username: ${{ secrets.USERNAME }} | |
password: ${{ secrets.PASSPHRASE }} | |
strip_components: 2 | |
overwrite: true | |
source: _build/dirhtml/ | |
target: /var/www/html/docs/ |