Skip to content

chore: standardize copyright boilerplate and enforce with CI - #765

Open
Prachi01Yadav wants to merge 5 commits into
kubeflow:mainfrom
Prachi01Yadav:fix-issue-566
Open

chore: standardize copyright boilerplate and enforce with CI#765
Prachi01Yadav wants to merge 5 commits into
kubeflow:mainfrom
Prachi01Yadav:fix-issue-566

Conversation

@Prachi01Yadav

Copy link
Copy Markdown

Fixes#566
Replaces #568

Summary

This PR standardizes our copyright headers across the whole repo and sets up CI to enforce them going forward. We're now properly reusing the centralized boilerplate checker from kubeflow/testing.

What changed:

  • Vendored the checker script: Copied boilerplate.py directly from kubeflow/testing (@60573e4) into hack/boilerplate/. I explicitly matched the vendoring pattern that kubeflow/trainer uses so we don't have to dynamically download the script in CI, and it keeps local dev fast and offline.
  • Added CI & Makefile target: Set up a new GitHub Action (code-quality-check.yaml) and a verify-boilerplate make target. It properly handles branch resolution on both pushes and PRs.
  • Added missing headers: Slapped the standard, year-less Apache 2.0 template onto 46 files that were missing it entirely. This includes:
    • 22 Python files (even the empty __init__.py ones, to be safe)
    • 13 GitHub Actions workflows
    • A bunch of YAML config files (dependabot, pre-commit, CRDs) and a Dockerfile.
    • (For files with shebangs, I made sure to safely insert the header immediately after line 1).
  • Left existing headers alone: Any files that already had a Copyright 2024 or 2025 header were intentionally left completely untouched to keep git blame clean and let the script's normalization logic do its job.

To test locally:
Just run make verify-boilerplate. (I've verified it locally and it passes with 1028 insertions and 0 deletions — strictly additive!).

Checklist:

  • Docs included if any changes are user facing

Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🎉 Welcome to the Kubeflow SDK! 🎉

Thanks for opening your first PR! We're happy to have you as part of our community 🚀

Here's what happens next:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

@google-oss-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign astefanutti for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tariq-hasan

Copy link
Copy Markdown
Member

/ok-to-test
/retest

Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
Comment threadhack/Dockerfile.spark-e2e-runner Outdated
Comment threadhack/boilerplate/boilerplate.py
Comment thread.github/workflows/code-quality-check.yaml
Prachi01Yadavand others added 2 commits August 20, 2026 11:21
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com>
Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize copyright boilerplate and enforce with CI workflow

4 participants

@Prachi01Yadav@tariq-hasan@andreyvelich@jaiakash