Skip to content

Preview the website on documentation pull requests - #8070

Open
dimitrieh wants to merge 10 commits into
mainfrom
docs-website-preview
Open

Preview the website on documentation pull requests#8070
dimitrieh wants to merge 10 commits into
mainfrom
docs-website-preview

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Contributes to Website preview on documentation pull requests.

Replaces the copy of the website build in docs.yml with a call to build_website/v1 in FlowFuse/github-actions-workflows, and uploads the result to Netlify under a docs-pr-<number> alias so documentation pull requests get a preview URL.

The deploy is aliased and unpublished, so netlify.toml's build command never runs against it and flowfuse.com keeps serving what it served before. Fork pull requests receive no secrets, so they build and link-check without uploading.

Draft until:

  • NETLIFY_AUTH_TOKEN and NETLIFY_SITE_ID are available to this repository
  • main's required checks name Build the website with these docs / Build and check in place of Test Documentation with website

test-with-website already checked out FlowFuse/website next to this repository
and built the whole site with the pull request's docs, because docs-sync.mjs
prefers a sibling checkout over cloning main. It then threw the output away
after the link check.

That build is now FlowFuse/website's site-preview.yml, called from here, so
this repository stops carrying a second copy of the website pipeline and picks
up changes to it as the Nuxt migration progresses. When the caller is a pull
request from a branch in this repository it also uploads the result to Netlify
under a docs-pr-<number> alias and reports the URL on the pull request.

The upload is an aliased, unpublished deploy: no --prod, and no --build, so
netlify.toml's build command (which reindexes Algolia) never runs against a
preview and flowfuse.com keeps serving whatever it served before.

test-with-website survives as a gate job so the check name and the publish
dependency are unchanged.
Without this the pull request that changes docs.yml does not trigger it, so the
build and the preview upload go unverified.
@dimitrieh

Copy link
Copy Markdown
Contributor Author

@dimitrieh

Copy link
Copy Markdown
Contributor Author

site-preview.yml no longer exists on FlowFuse/website. The definition moved to
FlowFuse/github-actions-workflows as build_website.yml, so the old reference
resolved to nothing. The inputs and secrets are unchanged, only the ref moves.
Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml
@dimitrieh

dimitrieh commented Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

The gate existed only to keep publishing the old check name. A reusable
workflow reports as "caller job / called job", so the website build now
reports as "Build the website with these docs / Build and check" and
publish depends on it directly.
@ZJvandeWeg

Copy link
Copy Markdown
Member

@dimitrieh Seems convoluted, shouldn't we just move the docs to the website repo?

@dimitrieh

dimitrieh commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants