DOM-79862: Clarify commit_id vs main_repo_git_ref for git-based projects - #280
Merged
ddl-rodrigo-fernandez merged 3 commits intoAug 19, 2026
Merged
Conversation
commit_id only pins the project's internal DFS commit and cannot pin a commit on a git-based project's main repository; main_repo_git_ref already supports type "commitId" for that, it just wasn't documented. No behavior change. See DOM-79862. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Same clarification as the job_start docstring update, applied to README.md and README.adoc so Mintlify's public docs stay in sync. DOM-79862. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ddl-adam-simpson
approved these changes
Aug 19, 2026
| from latest commit. | ||
| NOTE: for git-based projects, this pins the project's internal | ||
| DFS commit, NOT a commit on the main git repository. Passing a | ||
| commit SHA from the main repository here will fail. To pin a |
Contributor
There was a problem hiding this comment.
nit-ish correction: commit_id does not always "fail" on GBP, a valid DFS SHAs should still work on GBP
Contributor
Author
There was a problem hiding this comment.
Good catch, fixed — reworded to make clear commit_id always targets the DFS commit regardless of project type, and that a valid DFS SHA still works on a GBP project. Only a main-repo SHA (which isn't a DFS commit) fails.
commit_id doesn't unconditionally fail on git-based projects -- a valid DFS commit SHA still works there too. It only fails when the SHA isn't a valid DFS commit (e.g. a main-repo SHA). DOM-79862. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ddl-bira-ignacio
approved these changes
Aug 19, 2026
|
Docs PR opened: https://github.com/cerebrotech/documentation/pull/4678 Updated the python-domino SDK README snippet to clarify that commit_id pins the internal DFS commit only and main_repo_git_ref supports commitId. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to JIRA
DOM-79862
What issue does this pull request solve?
job_start(commit_id=<sha>)fails 100% of the time on git-based projects (GBP), becausecommit_idonly ever pins the project's internal DFS commit history — never a commit on the main git repository. The backend already has a companion PR (domino#48228) that rejects this combination up front with a clear error instead of failing deep inside the job pod. On the python-domino side, the actual correct mechanism —main_repo_git_ref={"type": "commitId", "value": <sha>}— already exists and already works (it's just an existingjob_startparameter), but this wasn't documented: the docstring only listed"branches"/"tags"as supportedmain_repo_git_reftypes, and nothing oncommit_idwarned it doesn't apply to GBP main repos. So there was no way for a user to discover the correct way to pin a GBP commit from the SDK docs alone.What is the solution?
Docs-only change, no behavior change:
commit_iddocstring now states it targets the internal DFS commit only, and won't work for pinning a GBP main-repo commit.main_repo_git_refdocstring now documents"commitId"as a supported type alongside"branches"/"tags", since the API already accepts it.[Unreleased] > Changed.Testing
Added
test_job_start_main_repo_git_ref_supports_commit_id_typetotests/test_jobs.py, confirming amain_repo_git_ref={"type": "commitId", ...}payload is passed through as-is and thatcommitIdstaysNonein the request body (i.e. the two fields are independent). Ran the fulltest_jobs.pysuite locally (27 passed, 6 skipped — the skips require a live Domino deployment) to confirm no regressions.Pull Request Reminders
References (optional)