Skip to content
Merged
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
32 changes: 18 additions & 14 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,20 @@ name: Docs

# Build the Antora site (with generated operator pages and the
# cross-backend coverage matrix) on every PR and push, and publish to
# GitHub Pages when a release is published, so the live site tracks the
# last released version. Dokka API bundling is wired in commit 6 of the
# GitHub Pages on every push to develop, so the live site tracks the
# last merge. Dokka API bundling is wired in commit 6 of the
# docs-to-Antora migration (see issue #494).
#
# Previously gated the deploy on `release: published`, matching the
# stated intent of "canonical site = latest release" — but this repo's
# actual release process only ever pushes a git tag, never a GitHub
# Release object, so that trigger has never once fired (issue #975).
# Deploying on every push to develop instead — same as
# SKaiNET-transformers' docs.yml — guarantees the site is never more
# than one merge behind, and is simpler than the release-gated version
# nobody was exercising. Revisit this pairing with #976 (versioned
# docs) if "canonical site = latest release" needs to come back as a
# distinct, working thing rather than "whatever's latest on develop".

on:
push:
Expand All @@ -22,14 +33,6 @@ on:
- 'build.gradle.kts'
- 'build-logic/**'
- 'skainet-lang/skainet-lang-core/**'
# Publish on release: the live site tracks the last released version.
# `release: published` is immune to the `paths:` filter above (so every
# release rebuilds docs) and checks out the released commit, where
# `generateDocs`/`dokkaGenerate` run live against the working tree — no
# need to commit generated pages. Single-version for now; a dedicated
# multi-repo aggregation site can come later (see issue #494).
release:
types: [ published ]
workflow_dispatch:

concurrency:
Expand Down Expand Up @@ -128,10 +131,11 @@ jobs:
path: docs/build/site

deploy-docs:
# Canonical site = latest release. Deploy only on a published release;
# develop/main pushes still run build-docs above for validation but no
# longer publish to Pages.
if: github.event_name == 'release'
# Deploy on every push to develop that touched docs-relevant paths (see
# the `on: push: paths:` filter above) — matches SKaiNET-transformers'
# docs.yml. PR builds and pushes to other branches still run build-docs
# for validation but don't publish.
if: github.ref == 'refs/heads/develop' && github.event_name == 'push'
needs: build-docs
runs-on: ubuntu-latest
environment:
Expand Down
Loading