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: apply license headers #204

Merged
merged 3 commits into from
Oct 18, 2024
Merged

chore: apply license headers #204

merged 3 commits into from
Oct 18, 2024

Conversation

mrjoelkamp
Copy link
Contributor

summary

  • applies license headers
  • adds header templates

@mrjoelkamp mrjoelkamp requested a review from a team as a code owner October 17, 2024 18:44
@github-actions github-actions bot added the chore label Oct 17, 2024
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.37%. Comparing base (79bbc9b) to head (01a6a2a).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #204      +/-   ##
==========================================
- Coverage   70.75%   66.37%   -4.38%     
==========================================
  Files          44       44              
  Lines        2595     3215     +620     
==========================================
+ Hits         1836     2134     +298     
- Misses        457      779     +322     
  Partials      302      302              
Flag Coverage Δ
unittests 66.37% <ø> (-4.38%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@jonnystoten jonnystoten left a comment

Choose a reason for hiding this comment

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

Looks like we need to outdent all of the comments in Go files to make the linter happy 😅

How do the templates work?

Do we need to include the year in the copyright notice in each file? Do we need to update them every year?

@mrjoelkamp
Copy link
Contributor Author

mrjoelkamp commented Oct 18, 2024

Looks like we need to outdent all of the comments in Go files to make the linter happy 😅

I was questioning this, I went with the template that was used in containerd per @thaJeztah's suggestion in the ticket we created.

I was planing on just ignoring the linter for these.

How do the templates work?

See https://github.com/containerd/ltag

Do we need to include the year in the copyright notice in each file? Do we need to update them every year?

Per suggestion and the ticket description, we only need to update copyright when we modify the file with the copyright notice in it.

I just re-read it and it seems the year is optional, so maybe we should just remove the year entirely?

@thaJeztah
Copy link
Member

FWIW, the ltag package works, but I've seen maintenance falling behind (still looking if possibly it should be transferred to (e.g.) the containerd org.

An alternative is a package provided by Google to do the same; I know we use that in this repository; PR below may help with the implementation;

@mrjoelkamp
Copy link
Contributor Author

I just re-read it and it seems the year is optional, so maybe we should just remove the year entirely?

removed year

@mrjoelkamp mrjoelkamp merged commit c7c3d23 into main Oct 18, 2024
8 of 9 checks passed
@mrjoelkamp mrjoelkamp deleted the chore-apply-license branch October 18, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants