Skip to content

ci: redeploy website on changelog updates#424

Open
Sayan- wants to merge 1 commit into
mainfrom
hypeship/docs-website-deploy-hook
Open

ci: redeploy website on changelog updates#424
Sayan- wants to merge 1 commit into
mainfrom
hypeship/docs-website-deploy-hook

Conversation

@Sayan-

@Sayan- Sayan- commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

The website's /changelog page prerenders content fetched at runtime from this repo's changelog.mdx, but merging a changelog entry here never triggers a website deploy — the page only updates via ISR, which has been silently not regenerating. As a result new changelog entries don't appear until the website is independently redeployed.

This adds a GitHub Actions workflow that fires a Vercel deploy hook for the website whenever changelog.mdx changes on main, so changelog edits show up without a manual redeploy.

Manual step required before this works

  1. In the website's Vercel project, create a Deploy Hook (Settings → Git → Deploy Hooks) targeting the production branch.
  2. Add the hook URL as a repo secret here named WEBSITE_VERCEL_DEPLOY_HOOK.

Until the secret exists, the job will fail fast with a clear message rather than silently no-op.

Notes

  • Scoped to changelog.mdx only, since that's the file the website fetches at runtime — avoids redeploying the site on unrelated docs edits.
  • Does not address the separate question of why ISR background regen stopped firing on that route; this is a reliable trigger regardless.

Note

Low Risk
CI-only change with no application code; deploy only runs when the secret is configured and changelog file changes.

Overview
Adds a GitHub Actions workflow that runs on pushes to main when changelog.mdx changes and POSTs to a Vercel deploy hook so the marketing site picks up changelog content without a manual deploy.

The job reads WEBSITE_VERCEL_DEPLOY_HOOK; if the secret is missing it exits with an error instead of no-oping. Path filtering limits runs to changelog edits only.

Reviewed by Cursor Bugbot for commit a895bea. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jun 26, 2026, 11:00 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@Sayan- Sayan- marked this pull request as ready for review June 26, 2026 22:59
@Sayan- Sayan- requested review from masnwilliams and removed request for masnwilliams June 26, 2026 22:59

@cursor cursor Bot 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.

Risk assessment: Medium.

This PR adds a new GitHub Actions workflow that runs on main pushes touching changelog.mdx and calls a Vercel deploy hook using the WEBSITE_VERCEL_DEPLOY_HOOK repository secret. The changed surface is small and scoped to the docs site, but it changes deployment automation and secret-backed CI behavior, so it has operational/infrastructure impact rather than being documentation-only or test-only.

Because the risk is Medium, I’m not approving this PR.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot 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.

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit a895bea. Configure here.

run: |
if [ -z "$DEPLOY_HOOK_URL" ]; then
echo "WEBSITE_VERCEL_DEPLOY_HOOK secret is not set; skipping."
exit 1

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Skip message contradicts failure exit

Low Severity

The deploy hook step logs "skipping" when WEBSITE_VERCEL_DEPLOY_HOOK is unset, but then exits with status 1, failing the workflow. This message implies a benign no-op, obscuring the intended fail-fast behavior and making CI failures harder to interpret.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a895bea. Configure here.

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.

1 participant