Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: deploy docs to github pages #521

Merged
merged 1 commit into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation

on:
pull_request:
push:
branches:
- master

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.9"
- name: Init python poetry action
uses: abatilo/[email protected]
with:
poetry-version: 1.8.3
- name: Install dependencies
run: poetry install
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Sphinx build
run: poetry run sphinx-build --define html_baseurl="${{ steps.pages.outputs.base_url }}" docs _site/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

deploy:
needs: build
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
9 changes: 6 additions & 3 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
name: Lint pyzeebe

on: [push, pull_request]
name: Lint

on:
pull_request:
push:
branches:
- master

jobs:
type-checking:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish pyzeebe
name: Publish

on:
release:
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Test pyzeebe

on: [push, pull_request]
on:
pull_request:
push:
branches:
- master

jobs:
# 3.6, 3.7 and 3.8 only for passing branch rules
Expand Down