-
Notifications
You must be signed in to change notification settings - Fork 208
feat: add workflow to revalidate SDK content on change #2333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
When MDX files in docs/pages are modified, call the docs-site revalidation API to invalidate the cache. This ensures content changes are reflected without waiting for a full re-index. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a GitHub Actions workflow to automatically revalidate SDK documentation content when MDX files are modified. When changes are pushed to the main branch that affect documentation files in docs/pages/, the workflow triggers an API call to invalidate the documentation site's cache, ensuring content updates are reflected immediately without requiring a full redeployment.
Changes:
- Added a new GitHub Actions workflow that triggers on pushes to main when
.mdor.mdxfiles indocs/pages/are modified - Workflow identifies changed files, transforms their paths from
docs/towallets/prefix to match the docs site's indexing structure, and calls a revalidation API endpoint - Updated the docs-site submodule reference
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/workflows/revalidate-sdk-content.yml | New workflow file implementing automatic cache revalidation for changed documentation files |
| docs-site | Submodule commit reference update |
🌿 Documentation Preview
|
When MDX files in docs/pages are modified, call the docs-site revalidation API to invalidate the cache. This ensures content changes are reflected without waiting for a full re-deploy.
Asana task
Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR introduces a GitHub Actions workflow named
Revalidate SDK Content, which triggers on pushes to themainbranch affecting specific Markdown files. It checks for changed files, prepares a JSON payload, and calls an API for revalidation.Detailed summary
.github/workflows/revalidate-sdk-content.ymlmainfor changes indocs/pages/**/*.mdanddocs/pages/**/*.mdx