Skip to content

Skip CI on first push to avoid race condition #91

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 1 commit into
base: main
Choose a base branch
from
Open

Skip CI on first push to avoid race condition #91

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
34 changes: 31 additions & 3 deletions src/stack_pr/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,9 @@ def draft_bitmask_type(value: str) -> list[bool]:
# ===----------------------------------------------------------------------=== #
# SUBMIT
# ===----------------------------------------------------------------------=== #
def add_or_update_metadata(e: StackEntry, *, needs_rebase: bool, verbose: bool) -> bool:
def add_or_update_metadata(
e: StackEntry, *, needs_rebase: bool, verbose: bool, skip_ci: bool = False
) -> bool:
if needs_rebase:
if not e.has_base() or not e.has_head():
error("Stack entry has no base or head branch")
Expand Down Expand Up @@ -565,6 +567,8 @@ def add_or_update_metadata(e: StackEntry, *, needs_rebase: bool, verbose: bool)

# Add the stack info metadata to the commit message
commit_msg += f"\n\nstack-info: PR: {e.pr}, branch: {e.head}"
if skip_ci:
commit_msg += "\n\n[skip ci]"
run_shell_command(
["git", "commit", "--amend", "-F", "-"],
input=commit_msg.encode(),
Expand All @@ -573,6 +577,25 @@ def add_or_update_metadata(e: StackEntry, *, needs_rebase: bool, verbose: bool)
return True


def remove_skip_ci_from_commits(st: list[StackEntry], *, verbose: bool) -> None:
"""Remove [skip ci] from all commit messages in the stack."""
for e in st:
run_shell_command(["git", "checkout", e.head], quiet=not verbose)
commit_msg = e.commit.commit_msg()
if "[skip ci]" in commit_msg:
# Remove [skip ci] with various spacing patterns
commit_msg = (
commit_msg.replace("\n\n[skip ci]", "")
.replace("\n[skip ci]", "")
.replace("[skip ci]", "")
)
run_shell_command(
["git", "commit", "--amend", "-F", "-"],
input=commit_msg.encode(),
quiet=not verbose,
)


def fix_branch_name_template(branch_name_template: str) -> str:
if "$ID" not in branch_name_template:
return f"{branch_name_template}/$ID"
Expand Down Expand Up @@ -1000,20 +1023,25 @@ def command_submit(
# Verify consistency in everything we have so far
verify(st)

# Embed stack-info into commit messages
# Embed stack-info into commit messages with [skip ci] for first push
log(h("Updating commit messages with stack metadata"), level=1)
needs_rebase = False
for e in st:
try:
needs_rebase = add_or_update_metadata(
e, needs_rebase=needs_rebase, verbose=args.verbose
e, needs_rebase=needs_rebase, verbose=args.verbose, skip_ci=True
)
except Exception:
error(ERROR_CANT_UPDATE_META.format(**locals()))
raise

push_branches(st, remote=args.remote, verbose=args.verbose)

# Remove [skip ci] from commit messages for final push
log(h("Removing [skip ci] from commit messages"), level=1)
remove_skip_ci_from_commits(st, verbose=args.verbose)
push_branches(st, remote=args.remote, verbose=args.verbose)

log(h("Adding cross-links to PRs"), level=1)
add_cross_links(st, keep_body=keep_body, verbose=args.verbose)

Expand Down