Skip to content

utils: Add function for getting git root #5

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

Open
tomtseng wants to merge 1 commit into
base: main
Choose a base branch
from
Open

utils: Add function for getting git root #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions {{cookiecutter.project_slug}}/src/{{cookiecutter.package_name}}/utils/batch_jobs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@

from {{ cookiecutter.project_name }}.configs import RunConfig
from {{ cookiecutter.project_name }}.constants import PROJECT_SHORT, WANDB_ENTITY, WANDB_PROJECT
from {{ cookiecutter.project_name }}.utils.git import git_latest_commit, validate_git_repo
from {{ cookiecutter.project_name }}.utils.git import get_repo_root, git_latest_commit, validate_git_repo

JOB_TEMPLATE_PATH = Path(__file__).parent.parent.parent / "k8s" / "batch_job.yaml"
JOB_TEMPLATE_PATH = get_repo_root() / "k8s" / "batch_job.yaml"
with JOB_TEMPLATE_PATH.open() as f:
JOB_TEMPLATE = f.read()

Expand Down
18 changes: 12 additions & 6 deletions {{cookiecutter.project_slug}}/src/{{cookiecutter.package_name}}/utils/git.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,28 @@

from {{ cookiecutter.project_name }}.utils.utils import ask_for_confirmation

JOB_TEMPLATE_PATH = Path(__file__).parent.parent.parent / "k8s" / "batch_job.yaml"
with JOB_TEMPLATE_PATH.open() as f:
JOB_TEMPLATE = f.read()
Copy link
Collaborator Author

@tomtseng tomtseng Jan 9, 2026

Choose a reason for hiding this comment

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

Not used



@functools.cache
def git_latest_commit() -> str:
"""Gets the latest commit hash."""
repo = Repo(".")
repo = Repo(".", search_parent_directories=True)
commit_hash = str(repo.head.object.hexsha)
return commit_hash


@functools.cache
def get_repo_root() -> Path:
"""Get the root directory of the git repository."""
repo = git.Repo(".", search_parent_directories=True)
working_dir = repo.working_tree_dir
if working_dir is None:
raise RuntimeError("Could not find git repository root")
return Path(working_dir)


def validate_git_repo() -> None:
"""Validates the git repo before running a batch job."""
repo = Repo(".")
repo = Repo(".", search_parent_directories=True)

# Push to git as we want to run the code with the current commit.
repo.remote("origin").push(repo.active_branch.name).raise_if_error()
Expand Down