feat: add reusable verify-boilerplate composite action - #1070
feat: add reusable verify-boilerplate composite action#1070Prachi01Yadav wants to merge 12 commits into
Conversation
Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
@Prachi01Yadav please check the nit comments, rest looks good to me. cc @tariq-hasan for review |
Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
tariq-hasan
left a comment
There was a problem hiding this comment.
I've just had a few additional comments. Overall lgtm. Thanks.
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Signed-off-by: Prachi01Yadav <archeyyadav111@gmail.com>
@tariq-hasan Thanks for the review! I've applied all your suggestions (removed the checkout/cleanup steps and simplified the fallback). Let me know if everything looks good now! |
tariq-hasan
left a comment
There was a problem hiding this comment.
Hi @Prachi01Yadav! I have added some further comments to help refine the first iteration and make it more robust.
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
Co-authored-by: Tariq Hasan <mmtariquehsn@gmail.com> Signed-off-by: Prachi Yadav <archeyyadav111@gmail.com>
|
Thanks @Prachi01Yadav! |
|
Depending on preference we can self-test this composite action directly on this testing repo (perhaps something like |
let's just test it directly in kubeflow/sdk#765, I can update that PR to use this action as soon as this is merged.. let me know if that sounds good to you |
Fixes #1069
What this PR does
Adds a reusable composite GitHub Action at
.github/actions/verify-boilerplate/that wraps the existinghack/boilerplate/boilerplate.pyscript, so Kubeflow subprojects can enforce Apache 2.0 copyright headers without vendoring the script.Requirements checklist
hack/boilerplate/boilerplate.py— script is sourced directly fromkubeflow/testingviaactions/checkoutwith sparse-checkout, so callers never vendor it.base-refinput defaults to the PR base branch (github.base_ref), so only changed/new files are flagged for year-less header enforcement.boilerplate-dirinput lets repos with custom templates point to their own directory. Defaults tokubeflow/testing's templates.setup-pythonstep (default3.12) so callers don't need to add one.Usage
Callers can use this action in their workflows like:
Context