Resolve product docs from the caller's checkout - #5473
Open
dimitrieh wants to merge 3 commits into
Open
Conversation
The docs source is now resolved in a documented order: FLOWFUSE_DOCS_LOCAL, a sibling flowfuse checkout, the snapshot committed to live, then a clone. Sibling detection is the convention CI depends on, so a docs PR is validated against its own changes rather than whatever main happens to be. Clone with full history so each page is dated from its own last commit, and have the build workflow commit the resolved docs onto live so production deploys use a pinned snapshot instead of cloning at deploy time.
Contributor
Author
|
comment with context at #5432 (comment) |
A second [build.environment] table is a TOML redefinition, which Netlify could not parse.
dimitrieh
marked this pull request as ready for review
August 3, 2026 09:46
Contributor
|
You need to get somebody who works on the WebSite to review this |
Contributor
Author
|
FlowFuse/flowfuse#8024 is intended to be merged after this one |
✅ Deploy Preview for flowforge-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
Review steps. Each row is what the change gives you, and how to confirm it.
Everything in the diff:
Wdyt? |
5 tasks
ZJvandeWeg
requested changes
Aug 3, 2026
| repository: 'FlowFuse/flowfuse' | ||
| ref: main | ||
| path: 'flowfuse' | ||
| # Full history: each docs page is dated from its own last commit. |
Member
There was a problem hiding this comment.
Hold on, we shouldn't need this. We're not doing a shallow clone?
| ref: main | ||
| path: 'flowfuse' | ||
| # Full history: each docs page is dated from its own last commit. | ||
| fetch-depth: 0 |
Member
There was a problem hiding this comment.
Please do a partial clone, not a shallow one.
| cd ./website | ||
| git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" | ||
| git config --local user.name "github-actions[bot]" | ||
| git add nuxt/content/docs nuxt/public/docs -A -f |
Member
There was a problem hiding this comment.
No, please don't. Why not clone on build time? You're reverting to do everything that wasn't great about this previously
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
3 participants
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.
Description
Docs resolution moves into
nuxt/lib/docs-sync.mjs, which looks for the docs in this order:FLOWFUSE_DOCS_LOCAL, a siblingflowfusecheckout, the snapshot committed onlive, then a download frommain.The sibling rule is the one #5177 removed. It means a local checkout is picked up with no setup, and the flowfuse doc check can build a docs PR against its own changes instead of against
main.Three smaller fixes ride along: clones keep full history, so each page gets its own "last updated" date instead of every page sharing one;
npm run docsis back; andbuild.ymlcommits the docs ontolive, so production deploys stop downloading them at deploy time.This does not change whether docs publish. That is FlowFuse/flowfuse#8029.
Review steps are in the comment below.
Related Issue(s)
Part of #5432
Checklist