Skip to content
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

Jump to bottom

Add pre-commit rules #7367

Merged
merged 4 commits into from
Feb 5, 2024
Merged

Add pre-commit rules #7367

merged 4 commits into from
Feb 5, 2024

Conversation

roman-kiselenko
Copy link
Contributor

@roman-kiselenko roman-kiselenko commented Nov 15, 2023 •
edited
Loading

Changes

This PR introduces the pre-commit hooks in tektoncd/pipeline repository.
A badge in README.md, a note in DEVELOPMENT.md, and in pull_request_template.

Hooks enabled:

Local:

  • make golangci-lint
  • make test-unit

Community:

Fix #7300

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@roman-kiselenko
add the config file for pre-commit
82af693 
Signed-off-by: roman-kiselenko <[email protected]>
@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Nov 15, 2023
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Nov 15, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@tekton-robot tekton-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 15, 2023
@tekton-robot
Copy link
Collaborator

Hi @roman-kiselenko. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roman-kiselenko
Copy link
Contributor Author

/kind misc

@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Nov 16, 2023
@roman-kiselenko
Copy link
Contributor Author

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@roman-kiselenko: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/test check-pr-has-kind-label

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@vdemeester
Copy link
Member

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 16, 2023
@roman-kiselenko roman-kiselenko marked this pull request as ready for review November 21, 2023 08:07
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 21, 2023
Yongxuanzhang
Yongxuanzhang reviewed Nov 21, 2023
View reviewed changes
.pre-commit-config.yaml
args: ["--allow-multiple-documents"]
# Ignore yaml files with {{ }} cause they're not valid.
exclude: '(test\/gohelloworld\/gohelloworld-chart\/templates\/.*yaml$)'
- id: check-shebang-scripts-are-executable
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious how this hook know which scripts need to be checked? Does it scan all the files' content?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, AFAIK it perform checks only against currently staged files
and only if file starts with shebang with respect of git config fileMode

@chmouel
Copy link
Member

chmouel commented Dec 21, 2023

/lgtm

Looking Good! 🤙🏽

@tekton-robot
Copy link
Collaborator

@chmouel: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Looking Good! 🤙🏽

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 21, 2023
@roman-kiselenko
Copy link
Contributor Author

Request review @tektoncd/maintainers

Does anything need to be done in order to merge this PR?

vdemeester
vdemeester approved these changes Feb 5, 2024
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll mark this one as approved. It's not enabled by default, so it's an opt-in for developer — I think we are ok merging this like that 👼🏼

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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

The pull request process is described here

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 5, 2024
@vdemeester
Copy link
Member

/retest

@tekton-robot tekton-robot merged commit ec051b2 into tektoncd:main Feb 5, 2024
7 checks passed
@roman-kiselenko roman-kiselenko deleted the add-pre-commit-rules branch February 5, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester approved these changes

@jerop jerop Awaiting requested review from jerop

@pritidesai pritidesai Awaiting requested review from pritidesai

@Yongxuanzhang Yongxuanzhang Awaiting requested review from Yongxuanzhang

Assignees

@vdemeester vdemeester

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pre-commit rules in tektoncd/pipeline repository
5 participants
@roman-kiselenko @tekton-robot @vdemeester @chmouel @Yongxuanzhang