docs: add preview feature functionality with GitHub workflows #6471
Conversation
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
antedotee
force-pushed
the
docs-preview-feature
branch
3 times, most recently
from
ed1389b to
6b34046
Compare
Contributor
Author
|
@eeshaanSA Please take a look. In case of any changes to make, let me know. |
antedotee
force-pushed
the
docs-preview-feature
branch
2 times, most recently
from
f60cd49 to
4b86daa
Compare
- Add docs preview check workflow - Add docs preview deploy workflow - Add docs preview cleanup workflow Signed-off-by: antedotee <soniyadav2051982@gmail.com>
Signed-off-by: antedotee <soniyadav2051982@gmail.com>
antedotee
force-pushed
the
docs-preview-feature
branch
from
4b86daa to
38c311e
Compare
eeshaanSA
reviewed
Jan 29, 2026
Contributor
eeshaanSA
left a comment
eeshaanSA
left a comment
There was a problem hiding this comment.
@antedotee, looks good on the first look. I will have to dive into the details of each file. Give me some time, I will get it reviewed.
Contributor
Author
|
Sorry for asking again😅, but did you have a look at this? |
Ayushmore1214
suggested changes
Feb 7, 2026
| name: Docs Preview Check | ||
|
|
||
| on: | ||
| pull_request: |
Contributor
There was a problem hiding this comment.
Should this run on pull_request_target for consistent behavior on forks?
| - name: Setup Node | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '14' |
Contributor
There was a problem hiding this comment.
Should this run on pull_request_target for consistent behavior on forks? Node 14 is EOL and is not supported but gh actions
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.
What this PR does:
This PR generates a github preview if the changes are made solely in the docs folder and generates a deployed website if the branch is prefixed with
docs-. The automation also added the deployed website which is made using gh pages in the PR description.Why we need it:
For better PR review velocity for maintainers
Which issue(s) this PR fixes:
Fixes #6467
I have tested the functionality locally on a seperate repo and it is working as expected. To make this work, after merging and the first workflow run, the pages settings of the repo will have to change to select gh pages from the list of branches (I have added a screenshot below for reference):
