Skip to content

docs: add GitHub Actions integration for AI agents #18845

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add GitHub Actions integration for AI agents #18845

wants to merge 2 commits into from

Conversation

blink-so[bot]
Copy link
Contributor

@blink-so blink-so bot commented Jul 14, 2025

Adds comprehensive documentation for the start-workspace-action GitHub Action that enables automatic workspace creation from GitHub issues and comments.

Changes

  • New documentation: docs/ai-coder/github-actions.md with usage examples, configuration options, and security best practices
  • Navigation update: Added entry to manifest.json for discoverability
  • Index update: Added GitHub Actions section to ai-coder/index.md

Features Documented

  • Automatic workspace creation from GitHub events
  • User mapping between GitHub and Coder accounts
  • Security recommendations for token management
  • AI agent integration examples
  • Troubleshooting guide

This addresses the need for better documentation of our AI agent GitHub Actions integration as requested in Slack.

blink-so bot and others added 2 commits July 14, 2025 12:12
@blink-so @kylecarbs
docs: add GitHub Actions integration for AI agents
2216095 
Adds comprehensive documentation for the start-workspace-action GitHub Action
that enables automatic workspace creation from GitHub issues and comments.

- Created docs/ai-coder/github-actions.md with usage examples and configuration
- Updated manifest.json to include new documentation in navigation
- Added GitHub Actions section to ai-coder/index.md for discoverability

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
@blink-so @kylecarbs
fix: format markdown tables in github-actions.md
8419992 
Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
@github-actions github-actions bot added the stale This issue is like stale bread. label Jul 22, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 22, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
stale This issue is like stale bread.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants