add docs on remote runs #2017

motatoes · 2025-07-10T23:30:09Z

Summary by CodeRabbit

Documentation
- Added a new guide explaining how to run remote jobs using the command line tool, including step-by-step instructions, example commands, and illustrative images.
- Updated documentation navigation to include the new remote jobs guide under the enterprise section.

coderabbitai · 2025-07-10T23:30:16Z

Caution

Review failed

The pull request is closed.

Walkthrough

A new documentation page describing remote job execution with dgctl has been added, including example usage and illustrative images. The documentation navigation configuration was updated to include this new page under the "Digger Enterprise" section.

Changes

File(s)	Change Summary
docs/ee/remote-jobs.mdx	Added new documentation detailing remote job execution, usage examples, and images.
docs/mint.json	Updated navigation to include the new "ee/remote-jobs" documentation page under enterprise docs.

Poem

In docs, a new tale unfolds with delight,
Of remote jobs running far from sight.
With zipped-up code and logs that stream,
RBAC and OPA guard the dream.
Now in the nav, it proudly shows—
A rabbit’s guide to remote job flows! 🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cddd136 and 7bdb1fa.

⛔ Files ignored due to path filters (3)

docs/images/ee/remote-runs-1.png is excluded by !**/*.png
docs/images/ee/remote-runs-2.png is excluded by !**/*.png
docs/images/ee/remote-runs-3.png is excluded by !**/*.png

📒 Files selected for processing (2)

docs/ee/remote-jobs.mdx (1 hunks)
docs/mint.json (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/dgctl-exec

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.

greptile-apps

PR Summary

Added documentation for remote job execution feature in Digger Enterprise Edition, enabling users to run Digger commands in remote CI environments with local log streaming.

Added new docs/ee/remote-jobs.mdx detailing dgctl remote execution functionality with command examples and screenshots
Updated docs/mint.json navigation structure to include the new remote-jobs documentation under Enterprise Edition section
Documentation covers basic usage and RBAC policy compliance requirements
Documentation would benefit from additional details about requirements and error scenarios

_{2 files reviewed, 2 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-07-10T23:30:41Z

docs/ee/remote-jobs.mdx

+These tasks follow the same RBAC rules specified in your [opa policies](/ee/opa). For example this command:
+
+```
+dgctl exec --project <project_name> --command "digger plan"


style: Add example with actual project name (e.g., --project 'dev/networking')

greptile-apps · 2025-07-10T23:30:41Z

docs/ee/remote-jobs.mdx

+![](/images/ee/remote-runs-1.png)
+
+![](/images/ee/remote-runs-2.png)
+
+![](/images/ee/remote-runs-3.png)


style: Add descriptive alt text for accessibility and SEO to all images

delve-auditor · 2025-07-10T23:31:14Z

✅ No security or compliance issues detected. Reviewed everything up to 7bdb1fa.

Security Overview

🔎 Scanned files: 5 changed file(s)

Detected Code Changes

Change Type	Relevant files
Documentation	► docs/remote-runs.md Add documentation for remote runs

Reply to this PR with @delve-auditor followed by a description of what change you want and we'll auto-submit a change to this PR to implement it.

add docs on remote runs

7bdb1fa

motatoes merged commit c565c98 into develop Jul 10, 2025
11 of 13 checks passed

greptile-apps bot reviewed Jul 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add docs on remote runs #2017

add docs on remote runs #2017

Uh oh!

motatoes commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 10, 2025 •

edited

Loading

Review failed

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Jul 10, 2025

Uh oh!

greptile-apps bot Jul 10, 2025

Uh oh!

delve-auditor bot commented Jul 10, 2025

Uh oh!

Uh oh!

add docs on remote runs #2017

add docs on remote runs #2017

Uh oh!

Conversation

motatoes commented Jul 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

delve-auditor bot commented Jul 10, 2025

Uh oh!

Uh oh!

motatoes commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)