airbyte-python-cdk/.github/workflows/pdoc_publish.yml at main · railsware/airbyte-python-cdk

60 lines (50 loc) · 1.49 KB

name: Publish Docs

on:
  push:
    branches:
      - main

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  publish_docs:
    runs-on: ubuntu-24.04
    environment:
      name: "github-pages"
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Set up Poetry
        uses: Gr1N/setup-poetry@v9
        with:
          poetry-version: "2.0.1"
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
          cache: "poetry"
      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Install dependencies
        run: poetry install --all-extras

      - name: Generate documentation
        run: |
          poetry run poe docs-generate

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: "docs/generated"

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Expand file tree

Search code, repositories, users, issues, pull requests...

Uh oh!

FilesExpand file tree

pdoc_publish.yml

Latest commit

History

pdoc_publish.yml

File metadata and controls

Expand file tree