Skip to content

harden api doc PR creation#285

Merged
thebiglabasky merged 2 commits intomainfrom
herve/harden-api-doc-pr-create
May 5, 2026
Merged

harden api doc PR creation#285
thebiglabasky merged 2 commits intomainfrom
herve/harden-api-doc-pr-create

Conversation

@thebiglabasky
Copy link
Copy Markdown
Contributor

@thebiglabasky thebiglabasky commented May 5, 2026

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Notes for the Reviewer

Handles transient gh pr create failures in the generated API endpoint workflow. GitHub can return a 504 after creating the PR; the previous script treated that as fatal and stopped processing later endpoints.

This change:

  • retries PR creation up to three times
  • checks whether an open PR exists for the pushed branch after each create failure
  • treats a found PR as success so the workflow can continue to the next endpoint
  • reapplies auto-generated and api-docs labels to recovered PRs, because the 504 can leave the PR created but unlabeled

Validation:

  • node --check .github/scripts/detect-new-endpoints.mjs
  • DRY_RUN=1 node .github/scripts/detect-new-endpoints.mjs

New Dependency Submission

None.

Screenshots

No visual changes.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 5, 2026

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview May 5, 2026, 5:29 PM

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

@thebiglabasky thebiglabasky marked this pull request as ready for review May 5, 2026 17:44
@thebiglabasky thebiglabasky merged commit bd505bb into main May 5, 2026
3 checks passed
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