Skip to content

More docs CI #456

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.

Sign up for GitHub

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

Open
lucasdemarchi wants to merge 4 commits into
base: master
Choose a base branch
from
Open

More docs CI #456

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2210dcd
ci: Do not use 'docs' target
lucasdemarchi Aug 10, 2026
93b2875
ci: Default steps to run on bash
lucasdemarchi Aug 10, 2026
c6307df
ci: Allow different ref for setup-os
lucasdemarchi Aug 10, 2026
514dece
ci: Only allow publishing docs from master branch or valid tag
lucasdemarchi Aug 10, 2026
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
37 changes: 34 additions & 3 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@ jobs:
runs-on: ubuntu-26.04
container:
image: 'ubuntu:26.04'
defaults:
run:
shell: bash
steps:
- name: Validate trigger
if: ${{ github.event_name == 'workflow_dispatch' }}
env:
INPUT_TAG: ${{ inputs.tag }}
run: |
Expand All @@ -40,18 +44,39 @@ jobs:
exit 1
fi

- name: Checkout
- name: Ref for setup
id: ref_for_setup
run: |
if [[ "${GITHUB_REF}" == refs/heads/ci-test-docs ]]; then
echo ref="ci-test-docs" >> $GITHUB_OUTPUT
else
echo ref="master" >> $GITHUB_OUTPUT
fi

- name: Checkout for setup-os
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ inputs.tag }}
ref: ${{ steps.ref_for_setup.outputs.ref }}

- name: Setup OS
uses: ./.github/actions/setup-os

- name: Checkout target ref for workflow_dispatch
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
if: ${{ github.event_name == 'workflow_dispatch' }}
with:
ref: ${{ inputs.tag }}

- name: Checkout target ref for normal triggers
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
if: ${{ github.event_name != 'workflow_dispatch' }}

- name: Build docs
run: |
meson setup --native-file build-dev.ini -Ddocs=true build-docs/
meson compile -C build-docs docs
# XXX: change this to `meson compile -C build-docs docs` once only
# v35+ is supported
ninja -C build-docs libkmod-3-doc

- name: Extract docs version
shell: bash
Expand Down Expand Up @@ -81,6 +106,12 @@ jobs:
if [[ "$PUBLISH" == "false" ]]; then
echo "publish=false" >> $GITHUB_OUTPUT
elif [[ "$PUBLISH" == "true" ]]; then
# this is a manual workflow, only allow to publish if being executed from master branch
# or a tag. We don't want a build from ci-test-docs to end up publishing anything
if [[ "${GITHUB_REF}" != refs/heads/master && "${GITHUB_REF}" != refs/tags/* ]]; then
echo "::error::Can't publish from branch != master or a valid tag (ref=${GITHUB_REF}"
exit 1
fi
echo "publish=true" >> $GITHUB_OUTPUT
elif [[ "${GITHUB_REF}" == refs/heads/master || "${GITHUB_REF}" == refs/tags/* ]]; then
echo "publish=true" >> $GITHUB_OUTPUT
Expand Down
Loading