Skip to content

fix docs for Git repository job run arg #1229

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

Merged
merged 1 commit into from
Jul 11, 2025
Merged

Conversation

shcheklein
Copy link
Member

@shcheklein shcheklein commented Jul 11, 2025

Docs update for job run command.

Summary by Sourcery

Add documentation for the new --repository option in the datachain job run command, including examples for specifying branches and using Git URLs.

Documentation:

  • Document the --repository flag for job run and its usage to clone a repository before execution.
  • Provide examples for specifying a branch or revision via URL suffix and using SSH Git URLs with revision suffixes.

Copy link
Contributor

sourcery-ai bot commented Jul 11, 2025

Reviewer's Guide

This PR enhances the job run command documentation by adding a new --repository flag and providing examples for branch/revision specification and Git URL support.

File-Level Changes

Change Details Files
Add --repository flag to job run options
  • Inserted bullet describing --repository URL flag
docs/commands/job/run.md
Provide example for specifying branch/revision
  • Added section heading for branch/revision usage
  • Included code snippet showing @main syntax
docs/commands/job/run.md
Demonstrate Git URL usage
  • Added section heading for Git URL support
  • Included code snippet with SSH Git URL and revision syntax
docs/commands/job/run.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@shcheklein shcheklein requested a review from a team July 11, 2025 17:35
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @shcheklein - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@shcheklein shcheklein requested a review from dmpetrov July 11, 2025 17:36
Copy link

Deploying datachain-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5e686d4
Status: ✅  Deploy successful!
Preview URL: https://f683f1ff.datachain-documentation.pages.dev
Branch Preview URL: https://fix-repo-job-run-docs.datachain-documentation.pages.dev

View logs

Copy link

codecov bot commented Jul 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.68%. Comparing base (2e433bb) to head (5e686d4).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1229      +/-   ##
==========================================
+ Coverage   88.66%   88.68%   +0.02%     
==========================================
  Files         152      152              
  Lines       13606    13606              
  Branches     1893     1893              
==========================================
+ Hits        12064    12067       +3     
+ Misses       1095     1093       -2     
+ Partials      447      446       -1     
Flag Coverage Δ
datachain 88.62% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@yathomasi yathomasi left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Copy link
Member

@dmpetrov dmpetrov left a comment

Choose a reason for hiding this comment

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

LG!

@shcheklein shcheklein merged commit fd3795e into main Jul 11, 2025
57 of 59 checks passed
@shcheklein shcheklein deleted the fix-repo-job-run-docs branch July 11, 2025 18:22
Comment on lines +77 to +81
Git URLs are also supported:

```bash
datachain job run --repository [email protected]:iterative/datachain.git@main query.py
```
Copy link
Member

Choose a reason for hiding this comment

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

Why should we document / support this "Git URLs" syntax?

Copy link
Member

Choose a reason for hiding this comment

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

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.

4 participants