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.

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

chore: make all file headers consistent #4075

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alexandear
Copy link
Contributor

@alexandear alexandear commented Jan 28, 2025

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Fixes copyright headers for Go files and make it consistent. Integrates goheader linter to automatically check the file header.

Special notes for your reviewer:

Changes:

  • Add missing file headers.
  • Add missing year.
  • Fix typos.

About goheader linter: https://golangci-lint.run/usage/linters/#goheader

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Jan 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found 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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @alexandear. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 28, 2025
Copy link

netlify bot commented Jan 28, 2025

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit caa0c38
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6798ad1eeeb4f30008a929f4
😎 Deploy Preview https://deploy-preview-4075--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mbobrovskyi
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-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 Jan 28, 2025
@mbobrovskyi
Copy link
Contributor

mbobrovskyi commented Jan 28, 2025

/lgtm
Thanks!

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

LGTM label has been added.

Git tree hash: 8933e7facf8c998350ad3374258590a1f0e36e80

regexp:
CopyrightDate: "Copyright \\d{4}"
template: |-
{{CopyrightDate}} The Kubernetes Authors.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
{{CopyrightDate}} The Kubernetes Authors.
The Kubernetes Authors.

The current template without year is intended.
We drop the year since we want to avoid the license update every year: #1590

Copy link
Member

Choose a reason for hiding this comment

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

Additionally, could we reuse this template instead of hardcoded one here?

https://github.com/kubernetes-sigs/kueue/blob/main/hack/boilerplate.go.txt

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I investigated PR #1590 before creating this one, and what I understood from the description is that it is only for generated code. This PR touches only human-added files, not the generated files.

In human-added files, there is no issue with updating the year every year. We add the year into license only on introducing a new file.

Are you sure I need to change the copyright template to be the same for human-added and generated files? It requires me to update roughly 6K files. It's not a big deal, just asking to be sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@alexandear alexandear requested a review from tenzen-y January 29, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", 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 doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants