Skip to content

Post preview links as part of build [DOC-792] - #54

Merged
mscwilson merged 13 commits into
mainfrom
fix-preview-links
Nov 18, 2026
Merged

mscwilson merged 13 commits into
mainfrom
fix-preview-links

Conversation

@mscwilson

@mscwilson mscwilson commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

It can be annoying to navigate to the changed pages in a PR's deploy preview to confirm they look alright. This PR adds a plugin that helps with this: it posts a comment in the PR with direct links to the changed pages, grouped by docs section and version.

The plugin runs during Netlify preview build. Each link shows the page title as well as the URL slug.

I've capped the main list at 8 links per section, with an additional 12 links each in a details dropdown. For more than 20 links it lists them and then says "plus X more, too many to list".

The comment won't appear if there's no deploy preview, or if no docs pages are changed.

If you update the PR, the comment will be updated to link to the current changed pages. If you remove all the changed pages, it'll be deleted.

Example comment:

Screenshot 2026-11-18 at 2 49 52 PM

@mscwilson
mscwilson requested a review from a team as a code owner October 28, 2026 13:25
@netlify

netlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for hazelcast-documentation ready!

Name Link
🔨 Latest commit a5c431e
🔍 Latest deploy log https://app.netlify.com/projects/hazelcast-documentation/deploys/6afdc425cb3874c4886a8e98
😎 Deploy Preview https://deploy-preview-54--hazelcast-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@mscwilson
mscwilson requested a review from cheels October 28, 2026 13:32
@hazelcast hazelcast deleted a comment from devOpsHazelcast Oct 29, 2026
@hazelcast hazelcast deleted a comment from devOpsHazelcast Oct 29, 2026
@mscwilson
mscwilson requested a review from a team November 2, 2026 18:21
@mscwilson mscwilson changed the title Post preview links as part of build Post preview links as part of build [DOC-792] Nov 4, 2026

@g-donev g-donev left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the idea. Let's do it.

@mscwilson
mscwilson merged commit c9f8075 into main Nov 18, 2026
6 checks passed
@mscwilson
mscwilson deleted the fix-preview-links branch November 18, 2026 15:33
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.

2 participants