Preview the website on documentation pull requests - #8070
Draft
dimitrieh wants to merge 3 commits into
Draft
Conversation
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.
5 tasks
Contributor
Author
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
test-with-websitealready checked out FlowFuse/website next to this repository and built the whole site with the PR's docs, becausedocs-sync.mjsprefers a sibling checkout over cloning main. It then discarded the output after the link check.That build now lives in FlowFuse/website as a reusable workflow, 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. Documentation PRs from a branch in this repository additionally get the build uploaded to Netlify under a
docs-pr-<number>alias, with the URL reported on the PR and recorded as aPreviewdeployment.The upload is an aliased, unpublished deploy: no
--prodand 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. Fork PRs receive no secrets, so they get the build and the link check without an upload.test-with-websitesurvives as a gate job, so its check name and thepublishdependency are unchanged. The workflow now also triggers on changes to itself, otherwise a workflow-only PR like this one would go unverified.Depends on FlowFuse/website#5515, which holds the reusable workflow.
Draft until:
@docs-preview-shared-buildmoves to@mainNETLIFY_AUTH_TOKENandNETLIFY_SITE_IDare available to this repository