Skip to content

Conversation

@codegen-sh
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jul 10, 2025

This PR adds comprehensive documentation for using the Codegen Python SDK with GitHub Actions, addressing a common customer need (40% of API questions).

What's Added

📚 New Documentation: docs/api-reference/github-actions.mdx

  • Complete setup guide for GitHub Actions + Codegen integration
  • Working code examples and workflow configurations
  • Security best practices and error handling
  • Troubleshooting section for common issues

🧭 Navigation Update: Updated docs/docs.json to include the new guide in the API Reference section

Key Features Covered

  • Basic Setup: Step-by-step instructions for setting up automated PR reviews
  • Advanced Configuration: Conditional reviews, custom review types, environment-specific workflows
  • Security: Proper credential management and best practices
  • Error Handling: Robust retry logic and timeout handling
  • Troubleshooting: Common issues and debugging techniques
  • Real Examples: Production-ready workflow configurations

Context

This addresses the webhook limitation where GitHub doesn't fire webhooks for bot users, preventing direct @codegen mentions in automated workflows. The GitHub Actions + API approach provides a reliable alternative for automated code reviews.

Files Changed

  • docs/api-reference/github-actions.mdx - New comprehensive guide
  • docs/docs.json - Updated navigation to include new guide

💻 View my workAbout Codegen

- Add comprehensive guide for using Codegen Python SDK with GitHub Actions
- Include setup instructions, workflow examples, and best practices
- Cover security, error handling, and troubleshooting
- Address common customer need for automated PR reviews
- Update docs navigation to include new guide
@codegen-sh codegen-sh bot requested review from a team and codegen-team as code owners July 10, 2025 23:37
@codecov
Copy link

codecov bot commented Jul 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

@jayhack jayhack merged commit 71b3a00 into develop Jul 10, 2025
18 checks passed
@jayhack jayhack deleted the codegen-bot/add-github-actions-docs-1752190634 branch July 10, 2025 23:39
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