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 hook to facilitate local testing #9158

Merged
merged 6 commits into from
Aug 24, 2022
Merged

add pre-commit hook to facilitate local testing #9158

merged 6 commits into from
Aug 24, 2022

Conversation

cristicalin
Copy link
Contributor

What type of PR is this?

/kind feature

What this PR does / why we need it:
This PR adds support for pre-commit to run some of the first steps in the CI as a pre-commit hook before pushing a PR, if properly used this should ensure we see better markdown files, and better linted yaml before the CI jobs are even triggered.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

[dev/docs] add support for pre-commit hook

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 8, 2022
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 8, 2022
@cristicalin cristicalin changed the base branch from pre-commit-hook to master August 8, 2022 11:47
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 8, 2022
@cristicalin
Copy link
Contributor Author

/retest

floryut
floryut reviewed Aug 9, 2022
View reviewed changes
CONTRIBUTING.md Outdated
5. Submit a pull request.
6. Work with the reviewers on their suggestions.
7. Ensure to rebase to the HEAD of your target branch and squash un-necessary commits (<https://blog.carbonfive.com/always-squash-and-rebase-your-git-commits/>) before final merger of your contribution.
4. Install [pre-commit](https://pre-commit.com) and install it in your development repo).
Copy link
Member

Choose a reason for hiding this comment

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

There is an extra ')' (or a missing one 😄 )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, you can't quite lint everything :)

@cristicalin
add pre-commit hook configuration
151171c
@cristicalin
add tmp.md to .gitignore
299f5de
@cristicalin
describe the use of pre-commit hook in CONTRIBUTING.md
4c6583d
@cristicalin
fix docs/integration.md errors identified by markdownlint
a3d82ac
@cristicalin
fix docs/<file>.md errors identified by markdownlint
4dd4dd8 
* docs/azure-csi.md
* docs/azure.md
* docs/bootstrap-os.md
* docs/calico.md
* docs/debian.md
* docs/fcos.md
* docs/vagrant.md
* docs/gcp-lb.md
* docs/kubernetes-apps/registry.md
* docs/setting-up-your-first-cluster.md
* docs/vagrant.md
* docs/vars.md
@cristicalin
fix contrib/<file>.md errors identified by markdownlint
62efcd4
@cristicalin
Copy link
Contributor Author

/cc @floryut @oomichi

floryut
floryut approved these changes Aug 24, 2022
View reviewed changes
Copy link
Member

@floryut floryut left a comment

Choose a reason for hiding this comment

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

/lgtm
Nice, let's hope contribs uses this :)

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 24, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cristicalin, floryut

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:
  • OWNERS [cristicalin,floryut]

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

@k8s-ci-robot k8s-ci-robot merged commit e6976a5 into kubernetes-sigs:master Aug 24, 2022
TinLe added a commit to TinLe/kubespray that referenced this pull request Aug 27, 2022
@TinLe
Merge remote-tracking branch 'upstream/master'
3fa0d59 
* upstream/master: (832 commits)
  add pre-commit hook to facilitate local testing (kubernetes-sigs#9158)
  cri-dockerd: add restart of docker.service (kubernetes-sigs#9205)
  do not run etcd role in scale.yml playbook when etcd installed by kubeadm (kubernetes-sigs#9210)
  optimize the format of evictionHard in kubelet-config.yaml template (kubernetes-sigs#9204)
  Update vars.md (kubernetes-sigs#9172)
  fix one bug in docs/nodes (kubernetes-sigs#9203)
  Fix containerd (<1.7) configuration for insecure registries (kubernetes-sigs#9207)
  🌱 Enable cri-dockerd service (kubernetes-sigs#9201)
  Update vsphere-csi.md (kubernetes-sigs#9170)
  9035: Make Cilium rolling-restart delay/timeout configurable (kubernetes-sigs#9176)
  [kubernetes] Add hashes for 1.24.4, 1.22.13, 1.23.10 and make v1.24.4 default (kubernetes-sigs#9191)
  Add 'avoid-buggy-ips' support of MetalLB (kubernetes-sigs#9166)
  Add the option to enable default Pod Security Configuration (kubernetes-sigs#9017)
  Add 'flush ip6tables' task in reset role (kubernetes-sigs#9168)
  add list nodes rules to cilium-operator clusterrole (kubernetes-sigs#9178)
  docs(kube-vip): fix broken links (kubernetes-sigs#9165)
  Disable DNSStubListener for Flatcar Linux (kubernetes-sigs#9160)
  Subnet setup order fix & Number of master nodes syntax fix (kubernetes-sigs#9159)
  Fix CSI drivers issues on Azure (kubernetes-sigs#9153)
  [calico] calico rr supports multiple groups (kubernetes-sigs#9134)
  ...
alegrey91 pushed a commit to alegrey91/kubespray that referenced this pull request Aug 29, 2022
@cristicalin @alegrey91
add pre-commit hook to facilitate local testing (kubernetes-sigs#9158)
bcbe249 
* add pre-commit hook configuration

* add tmp.md to .gitignore

* describe the use of pre-commit hook in CONTRIBUTING.md

* fix docs/integration.md errors identified by markdownlint

* fix docs/<file>.md errors identified by markdownlint

* docs/azure-csi.md
* docs/azure.md
* docs/bootstrap-os.md
* docs/calico.md
* docs/debian.md
* docs/fcos.md
* docs/vagrant.md
* docs/gcp-lb.md
* docs/kubernetes-apps/registry.md
* docs/setting-up-your-first-cluster.md
* docs/vagrant.md
* docs/vars.md

* fix contrib/<file>.md errors identified by markdownlint
rptaylor pushed a commit to rptaylor/kubespray that referenced this pull request Aug 30, 2022
@cristicalin @rptaylor
add pre-commit hook to facilitate local testing (kubernetes-sigs#9158)
e682c44 
* add pre-commit hook configuration

* add tmp.md to .gitignore

* describe the use of pre-commit hook in CONTRIBUTING.md

* fix docs/integration.md errors identified by markdownlint

* fix docs/<file>.md errors identified by markdownlint

* docs/azure-csi.md
* docs/azure.md
* docs/bootstrap-os.md
* docs/calico.md
* docs/debian.md
* docs/fcos.md
* docs/vagrant.md
* docs/gcp-lb.md
* docs/kubernetes-apps/registry.md
* docs/setting-up-your-first-cluster.md
* docs/vagrant.md
* docs/vars.md

* fix contrib/<file>.md errors identified by markdownlint
@floryut floryut mentioned this pull request Sep 19, 2022
Closed
nolimitkun pushed a commit to nolimitkun/kubespray that referenced this pull request Mar 19, 2023
@cristicalin @nolimitkun
add pre-commit hook to facilitate local testing (kubernetes-sigs#9158)
616a553 
* add pre-commit hook configuration

* add tmp.md to .gitignore

* describe the use of pre-commit hook in CONTRIBUTING.md

* fix docs/integration.md errors identified by markdownlint

* fix docs/<file>.md errors identified by markdownlint

* docs/azure-csi.md
* docs/azure.md
* docs/bootstrap-os.md
* docs/calico.md
* docs/debian.md
* docs/fcos.md
* docs/vagrant.md
* docs/gcp-lb.md
* docs/kubernetes-apps/registry.md
* docs/setting-up-your-first-cluster.md
* docs/vagrant.md
* docs/vars.md

* fix contrib/<file>.md errors identified by markdownlint
LuckySB pushed a commit to southbridgeio/kubespray that referenced this pull request Jul 7, 2023
@cristicalin @LuckySB
add pre-commit hook to facilitate local testing (kubernetes-sigs#9158)
10161a8 
* add pre-commit hook configuration

* add tmp.md to .gitignore

* describe the use of pre-commit hook in CONTRIBUTING.md

* fix docs/integration.md errors identified by markdownlint

* fix docs/<file>.md errors identified by markdownlint

* docs/azure-csi.md
* docs/azure.md
* docs/bootstrap-os.md
* docs/calico.md
* docs/debian.md
* docs/fcos.md
* docs/vagrant.md
* docs/gcp-lb.md
* docs/kubernetes-apps/registry.md
* docs/setting-up-your-first-cluster.md
* docs/vagrant.md
* docs/vars.md

* fix contrib/<file>.md errors identified by markdownlint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@floryut floryut floryut approved these changes

@liupeng0518 liupeng0518 Awaiting requested review from liupeng0518

@oomichi oomichi Awaiting requested review from oomichi

Assignees

@floryut floryut

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cristicalin @k8s-ci-robot @floryut