[DOCS-1262] Add GH action for per-page preview links #1091
+112
−0
Conversation
This file contains 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
HTML previews:
Preview links work **only** after the `Cloudflare Pages` build check succeeds. Links are generated only for new and modified |
Deploying docs with
|
| Latest commit: |
3787b25
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4d312017.docodile.pages.dev |
| Branch Preview URL: | https://docs-1262.docodile.pages.dev |
mdlinville
force-pushed
the
DOCS-1262
branch
2 times, most recently
from
2b35400 to
804c577
Compare
mdlinville
force-pushed
the
DOCS-1262
branch
13 times, most recently
from
d1dc1ea to
b1c94ea
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
mdlinville
force-pushed
the
DOCS-1262
branch
9 times, most recently
from
ef782dc to
8292892
Compare
mdlinville
force-pushed
the
DOCS-1262
branch
14 times, most recently
from
e77d5a5 to
93b0bef
Compare
mdlinville
force-pushed
the
DOCS-1262
branch
from
93b0bef to
5a51587
Compare
ngrayluna
requested changes
Feb 14, 2025
| issue-number: ${{ github.event.pull_request.number }} | ||
| edit-mode: replace | ||
| body: | | ||
| <h3>HTML previews:</h3><ul>${{ env.body }}</ul><p>Preview links work **only** after the `Cloudflare Pages` build check succeeds. Links are generated only for new and modified <code>.md</code> files under <code>content/</code>.</p><p><a href="https://github.com/wandb/docs/issues/new?title=Feedback+about+HTML+preview+comments&assignees=mdlinville&body=Link+to+PR+and+describe+the+issue">Feedback about HTML previews</a> |
There was a problem hiding this comment.
If we want to be concise with the comment, we can move:
"Links are generated only for new and modified .md files under content/."
to a CONTRIBUTING.md file.
.github/workflows/changed_files.yml
Outdated
| output+="<li>$file</li>" | ||
| } | ||
|
|
||
| for file in ${files[@]}; do |
There was a problem hiding this comment.
The format of the markdown is a little confusing.
Can separate the non generated vs generated links into separate sections or add "Generated preview" to the second bullet point in body?
i.e. From this:
HTML previews:
- No preview: filename
- filename (generated preview)
To something like:
HTML previews:
- No preview generated for: filename
- Generated preview: filename, filename, filename
or perhaps even
HTML previews:
- No preview generated for:
- filename
- filename
- Generated preview:
- filename
- filename
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DOCS-1262 Add GH action for per-page preview links to aid review of docs PRs
content/**/*.mdto the corresponding Cloudflare URL, including interpreting_index.mdDocs: https://github.com/marketplace/actions/changed-files
Inspiration: https://github.com/cockroachdb/docs/blob/main/.github/workflows/changed_files.yml