Skip to content

Conversation

@lucasfcosta
Copy link
Contributor

@lucasfcosta lucasfcosta commented Dec 8, 2025

This PR is similar to the ones we have for the API and dashboard: it will automatically trigger docs updates when changes are merged to main on this repo.

This helps us keep the docs up-to-date when the node SDK changes.

For now, I will not do similar PRs on other SDKs given we mostly maintain the Node.js. Once we confirm it's working well here we can bring this to the other SDKs.

Note that I also double checked the access to these env vars and possibilities of who can run the workflow etc, but I'd appreciate further checks from reviewers too.


Summary by cubic

Automatically update Resend docs when the Node.js SDK changes by adding a GitHub Actions workflow that calls the Mintlify Agent on merges to main. This keeps API reference and examples in sync without manual effort.

  • New Features
    • Adds .github/workflows/update-docs.yml triggered on push to main for src/**/*.ts (resend/resend-node only).
    • Sends commit context to Mintlify Agent to create/update docs PRs when changes are customer-facing.
    • Uses MINTLIFY_API_KEY and MINTLIFY_PROJECT_ID secrets; falls back to HEAD commit if none in event.
    • Logs success/failure and enforces conventional commit titles for agent-created PRs.

Written for commit 8a9332d. Summary will update automatically on new commits.

@lucasfcosta lucasfcosta requested a review from a team as a code owner December 8, 2025 16:25
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

@lucasfcosta lucasfcosta merged commit b5f0cec into canary Dec 8, 2025
11 of 12 checks passed
@lucasfcosta lucasfcosta deleted the feat/auto-docs-update-via-mintlify branch December 8, 2025 20:35
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.

4 participants