Do not allow for any pushes to customer jars if the branch is dirty and not pushed to remote

[david-zlai]

Summary

I've been seeing that it's difficult to track what changes went into artifacts we push to etsy and canary. Especially when it comes to tracking performance regressions for spark jobs one day to the next.

Adding a check to not allow any pushes to any customer artifacts if the branch is dirty. All changes need to at least be pushed to remote.

And adding a metadata tag of the commit and branch

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested
• Documentation update

Summary by CodeRabbit

• New Features
  • Introduced consistency checks during the build and upload process to verify that local changes are committed and branches are in sync.
  • Enhanced artifact metadata now includes additional context about the code state at the time of upload.

[coderabbitai]

Walkthrough

The pull request enhances the build_and_upload_gcp_artifacts.sh script by adding pre-build checks. It now verifies that there are no uncommitted changes and that the local branch is synchronized with the remote. Additionally, the script has been modified to include more detailed metadata—specifically, the current git commit hash and branch name—when uploading artifacts to GCP.

Changes

File	Change Summary
distribution/build_and_upload_gcp_artifacts.sh	Added a check for uncommitted changes and a remote branch synchronization check before proceeding; enhanced uploaded artifact metadata with commit hash and branch.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as Build Script
    participant G as Git Repo

    U->>S: Trigger build and upload
    S->>G: Check for uncommitted changes
    alt Uncommitted changes present
        G-->>S: Report changes
        S->>U: Display error & exit
    else No uncommitted changes
        S->>G: Fetch latest remote branch
        alt Local branch behind remote
            G-->>S: Indicate remote updates
            S->>U: Display sync error & exit
        else Local branch synced
            S->>S: Prepare metadata (commit hash, branch)
            S->>U: Proceed with artifact upload
        end
    end

Loading

Possibly related PRs

• Add custom metadata to track who has uploaded and when for artifacts #374: Enhances metadata in the artifact upload script with custom metadata, aligning with the changes introduced here.

Suggested reviewers

• chewy-zlai
• nikhil-zlai

Poem

Code checks now guard our way,
Uncommitted changes kept at bay.
Branches sync in perfect hue,
Metadata shines, fresh and new.
Artifacts fly with commit and branch, 🚀✨
Clean builds make the coder's day!

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

distribution/build_and_upload_gcp_artifacts.sh (3)

3-7: Ensure clean working directory.
The check works but consider using git status --porcelain to also catch untracked files.

---

15-20: Check branch synchronization.
The diff check detects divergence. For robustness, consider alternatives like git diff --quiet or counting commits to explicitly handle both ahead and behind cases.

---

107-111: Enhance metadata for uploads.
Including commit hash and branch improves traceability. Consider caching these values (e.g., assign to variables once) to avoid redundant calls.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 277f040 and dfe1b2f.

📒 Files selected for processing (1)

• distribution/build_and_upload_gcp_artifacts.sh (2 hunks)

🔇 Additional comments (2)

distribution/build_and_upload_gcp_artifacts.sh (2)

9-11: Retrieve branch name.
Using git rev-parse --abbrev-ref HEAD is a standard approach.

---

12-14: Fetch remote updates.
Fetching the latest changes for the current branch keeps the check robust.