Skip to content

Clarify the permissions that CodeRabbit needs. #460

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

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

Conversation

jmacdotorg
Copy link
Contributor

Copy link
Contributor

coderabbitai bot commented Jul 17, 2025

Walkthrough

The documentation for generating a Personal Access Token in Azure DevOps was updated to clarify the specific permissions required. The instructions now explicitly mention "Read, write, & manage" access for "Work Items" and "Code," and recommend "Read" access to "Build" for Pro tier users. Step numbering and instructions were also adjusted.

Changes

File(s) Change Summary
docs/platforms/azure-devops.md Revised instructions to clarify required permissions for Azure DevOps PAT, updated step numbering.

Assessment against linked issues

Objective Addressed Explanation
Clarify and align documentation on required Azure DevOps PAT permissions (#392)

Poem

A hop and a skip through Azure’s domain,
Now permissions are clear—no more guessing in vain!
With steps all aligned and access precise,
CodeRabbit’s advice is clear and concise.
So here’s to good docs and tokens anew,
🐇💻—Azure, we’re ready for you!

Impact Analysis

Clarify Azure DevOps Personal Access Token permissions requirements

📢 Medium 🔄 Impacts behavior 🔒Impacts security

Updated the Azure DevOps setup documentation to require Read, write & manage access for “Work Items” and “Code” when creating a Personal Access Token (PAT) to enable posting code reviews, and recommends Read access to “Build” for Pro subscribers to support pipeline failure remediation. A new step for clicking “Create” was added and step numbering was adjusted.

Verify that the documented permission scopes match the actual requirements in Azure DevOps and consider if any additional scopes (e.g., “Packaging” or “Release”) need mention for related workflows.

Follow the revised instructions end-to-end: generate a PAT with the specified scopes, confirm you can post code reviews, and for Pro accounts, validate you can view build details when pipelines fail.

🔍 Related Files
  • docs/platforms/azure-devops.md

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • CIRCLECI integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch azure

🪧 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 auto-generate unit tests to generate unit tests for 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/platforms/azure-devops.md (1)

99-99: Minor punctuation nitpick
Add a trailing period for consistency with the previous steps.

-9. Click "Create"
+9. Click "Create".
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75408fc and 30ac13b.

📒 Files selected for processing (1)
  • docs/platforms/azure-devops.md (1 hunks)
🔇 Additional comments (1)
docs/platforms/azure-devops.md (1)

97-98: Re-check whether “Manage” scope is truly required
Granting the full Read, write, & manage permission set gives the PAT the ability to delete repos, administer branch policies, etc. If CodeRabbit only needs to read PRs and post review comments, Write on “Work Items” and “Code” is usually enough; “Manage” may violate the principle of least privilege. Please verify against the product’s API calls and trim the scope if possible.

Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 30ac13b
Status: ✅  Deploy successful!
Preview URL: https://81c16501.coderabbit-docs.pages.dev
Branch Preview URL: https://azure.coderabbit-docs.pages.dev

View logs

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.

Clarify what permissions is actually needed for Azure Devops PAT
2 participants