Skip to content

Commit

Permalink
ci: Add dedicated job for documentation pages
Browse files Browse the repository at this point in the history
The Fedora jobs build and deploy documentation twice, and that may be
a problem.

Use a dedicated workflow with proper a deploy job. This uses the Github
Pages deploy action.
  • Loading branch information
GeorgesStavracas committed Sep 2, 2024
1 parent 58d4567 commit 0f5cc08
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 8 deletions.
8 changes: 0 additions & 8 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,6 @@ jobs:
run: meson setup --prefix=/usr _build -Dbackend-gtk3=enabled -Dbackend-gtk4=enabled -Dbackend-qt5=enabled -Dbackend-qt6=enabled
- name: Build libportal
run: ninja -C_build
- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v3
if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_build/doc/libportal-1/
cname: libportal.org
destination_dir: ./

abi-check:
name: ABI check
Expand Down
61 changes: 61 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Documentation

on: [push, pull_request]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
container:
image: fedora:latest

steps:
- name: Install dependencies
run: |
dnf install -y \
gcc \
gi-docgen \
git \
gobject-introspection-devel \
meson \
python3-pytest \
python3-dbusmock
- name: Check out libportal
uses: actions/checkout@v4

- name: Configure libportal
run: meson setup --prefix=/usr builddir -Dtests=false -Dvapi=false

- name: Build libportal
run: ninja -C builddir doc/libportal-1

- name: Prepare docs
working-directory: builddir/doc
run: |
mv ./libportal-1 ../../_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
needs: build
runs-on: ubuntu-latest
if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

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

0 comments on commit 0f5cc08

Please sign in to comment.