Skip to content

Update submodule updater script #706

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
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Update submodule updater script #706

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fee9f22
Updated deprecated code.
pbehne Nov 13, 2025
c3ef6be
Put verbose output in PR description.
pbehne Nov 13, 2025
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
34 changes: 25 additions & 9 deletions scripts/submodule_updater.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def load_remote(repo, remote, config_tokens):
raise SystemExit(f'API token for {host} not found')

if 'github' in host:
github_kwargs = {'login_or_token': config_tokens[host]}
github_kwargs = {'auth': github.Auth.Token(config_tokens[host])}
if host != 'github.com':
github_kwargs['gh_url'] = 'https://' + host + '/api/v3'
gh = github.Github(**github_kwargs)
Expand Down Expand Up @@ -110,10 +110,14 @@ def load_remote(repo, remote, config_tokens):
if submodule.module_exists():
submodules.append(submodule)

pr_body_text = "Updates application submodules:\n"

submodule_sha1 = {}
# Load the hpc submodules if requested
if args.use_hpc_submodules:
print('Looking for hpc submodule versions')
info = 'Looking for hpc submodule versions'
print(info)
pr_body_text += f"{info}\n"
for submodule in submodules:
sm_name = submodule.name.split('apps/')[-1].replace('_', '').lower()
# This regex assumes the latest date is the last line
Expand All @@ -123,9 +127,13 @@ def load_remote(repo, remote, config_tokens):
if sha1 == '':
raise ValueError
submodule_sha1[submodule.name] = sha1
print(f" - Found hpc sha {sha1} for submodule {sm_name}")
info = f" - Found hpc sha {sha1} for submodule {sm_name}"
print(info)
pr_body_text += f"{info}\n"
except:
print(f" - Could not determine hpc version for {sm_name}. Falling back to default behavior.")
info = f" - Could not determine hpc version for {sm_name}. Falling back to default behavior."
print(info)
pr_body_text += f"{info}\n"
continue

# Load the user-provided submodules
Expand All @@ -147,7 +155,9 @@ def load_remote(repo, remote, config_tokens):
git_repo.git.fetch(base_remote)
git_repo.git.reset(f'{base_remote}/{base_branch}', hard=True)

print('Updating submodules')
info = 'Updating submodules'
print(info)
pr_body_text += f"{info}\n"
submodules_left = list(submodule_sha1.keys())
for submodule in submodules:
if submodule.name in submodule_sha1:
Expand All @@ -156,16 +166,22 @@ def load_remote(repo, remote, config_tokens):
else:
sha1 = 'origin/master'
if args.skip_submodules is not None and submodule.name in args.skip_submodules:
print(f' - {submodule} SKIPPED')
info = f' - {submodule} SKIPPED'
print(info)
pr_body_text += f"{info}\n"
continue
print(f' - {submodule} to {sha1}')
info = f' - {submodule} to {sha1}'
print(info)
pr_body_text += f"{info}\n"
sm_git_repo = git.Repo(os.path.join(repo_path, submodule.path))
sm_git_repo.git.fetch('origin')
sm_git_repo.git.checkout(sha1)
git_repo.git.add(submodule.name)

for submodule_name in submodules_left:
print(f' User-specified submodule {submodule_name} SKIPPED (not a valid submodule)')
info = f' User-specified submodule {submodule_name} SKIPPED (not a valid submodule)'
print(info)
pr_body_text += f"{info}\n"

# If there is a diff between HEAD and the index
# i.e., if there is something to commit
Expand Down Expand Up @@ -196,7 +212,7 @@ def load_remote(repo, remote, config_tokens):

if not has_pr:
pr = base_repo_api.create_pull(title='Submodule update',
body='Updates application submodules',
body=pr_body_text,
head=f'{head_namespace}:{head_branch}',
base=base_branch)
print(f'Created pull request {pr.html_url}')
Expand Down