Skip to content

docs: add mkdocs documentation #317

docs: add mkdocs documentation

docs: add mkdocs documentation #317

Workflow file for this run

name: CI
on:
push:
branches:
- 'develop'
pull_request:
branches:
- '*'
workflow_call:
jobs:
CI:
name: Launching CI
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10']
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install poetry
run: make download-poetry
- name: Set up pip cache
uses: actions/[email protected]
with:
path: ~/.cache/pypoetry/virtualenvs
key: venv-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}
- name: Set Poetry Path
run: |
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
- name: Install requirements
run: |
poetry run pip install --upgrade pip
poetry install
- name: Run Pre commit hooks
run: make format-code
- name: Run tests
run: make run-tests
CLI-Integration-Tests:
name: Launching CLI Integration Tests
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10']
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install poetry
run: make download-poetry
- name: Set up pip cache
uses: actions/[email protected]
with:
path: ~/.cache/pypoetry/virtualenvs
key: venv-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}
- name: Set Poetry Path
run: |
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
- name: Install requirements
run: |
poetry run pip install --upgrade pip
poetry install
- name: Test root command
run: |
cd example
poetry run vertex-deployer --version
- name: Test list command
run: |
cd example
poetry run vertex-deployer list --with-configs
- name: Test check command
run: |
cd example
poetry run vertex-deployer -log DEBUG check --all
- name: Test deploy command
# Cannot check more than compile action here, need GCP environment for upload, run, schedule
run: |
cd example
poetry run vertex-deployer -log DEBUG deploy dummy_pipeline --compile --env-file example.env
- name: Test create command
run: |
cd example
poetry run vertex-deployer create test_pipeline --config-type py
[ -e vertex/pipelines/test_pipeline.py ] && echo 1 || echo 0