fix: update doc of kafka connector demo for #3993 (#3995) #1810
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: documents | |
# Doc workflow deploy to https://4paradigm.github.io/OpenMLDB/ | |
# | |
# Deployment requires main(default) branch and all vX.Y branches exists. | |
# Workflow triggers only on main branch, based on the model that all patches | |
# to vX.Y branches will first goes to main. | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- .github/workflows/doc.yml | |
- 'docs/**' | |
pull_request: | |
paths: | |
- .github/workflows/doc.yml | |
- 'docs/**' | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow one concurrent deployment | |
concurrency: | |
group: pages-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: setup poetry | |
run: | | |
pipx install poetry | |
- name: doc build (pr) | |
working-directory: docs | |
if: github.event_name == 'pull_request' | |
run: | | |
make all-local | |
- name: doc build (branch) | |
working-directory: docs | |
if: github.event_name == 'push' | |
run: | | |
make | |
- name: upload artifact | |
if: github.event_name == 'push' | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: docs/build/ | |
# Deployment job | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
if: github.event_name == 'push' | |
steps: | |
# This action expects an artifact named github-pages to have been created prior to execution. | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |