feat: add reusable verify-boilerplate composite action - #1071
Open
TrueFurina wants to merge 1 commit into
Open
Conversation
|
[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 |
| @@ -0,0 +1,38 @@ | |||
| name: "Verify Boilerplate Copyright Headers" | |||
| description: >- | |||
| Runs kubeflow/testing's hack/boilerplate/boilerplate.py against the repo's | |||
Member
There was a problem hiding this comment.
Please use a spell checker.
Repo -> repository
| inputs: | ||
| base-ref: | ||
| description: >- | ||
| Base ref to diff against for new-file detection. Defaults to the PR base |
| Runs kubeflow/testing's hack/boilerplate/boilerplate.py against the repo's | ||
| changed files so callers never need to vendor a divergent copy of the script. | ||
| inputs: | ||
| base-ref: |
| branch (github.base_ref). | ||
| required: false | ||
| default: ${{ github.base_ref }} | ||
| boilerplate-dir: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a reusable composite action (
.github/actions/verify-boilerplate) that wraps this repo'shack/boilerplate/boilerplate.py, so Kubeflow repos can call it directly instead of vendoring and maintaining a divergent copy of the script (which currently drifts and makes the "downloaded from kubeflow/testing @ " comment unverifiable).Requirements met
hack/boilerplate/boilerplate.py, script sourced from this repo — callers never vendor itbase-refinput defaulting togithub.base_ref(PR base branch), so only changed/new files drive new-file detectionboilerplate-dirinput for repos that keep custom templates (defaults to this repo's templates)actions/setup-python) so callers don't each add a setup stepChanges
.github/actions/verify-boilerplate/action.ymlVerification
runs.using: composite)github.base_refandgithub.action_pathcorrectly