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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: added header checker #1285

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: added header checker #1285

wants to merge 3 commits into from

Conversation

kikoso
Copy link
Collaborator

@kikoso kikoso commented Dec 7, 2023

This PR adds a new GitHub flow to check whether our files contain a copyright header.

Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Edit the title of this pull request with a semantic commit prefix (e.g. "fix: "), which is necessary for automated release workflows to decide whether to generate a new release and what type it should be.
  • Will this cause breaking changes to existing Java or Kotlin integrations? If so, ensure the commit has a BREAKING CHANGE footer so when this change is integrated a major version update is triggered. See: https://www.conventionalcommits.org/en/v1.0.0/
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #1284 馃

@kikoso kikoso requested a review from a team as a code owner December 7, 2023 14:06
@kikoso kikoso requested a review from amuramoto December 7, 2023 14:06
@wangela
Copy link
Member

wangela commented Dec 9, 2023

Should we add .gradle files too?

@kikoso
Copy link
Collaborator Author

kikoso commented Dec 15, 2023 •
edited

Should we add .gradle files too?

We generally do not add them in other repost, and generally they do not contain any relevant code besides the build support. Unless there is a non-technical reason we could leave them out.

Update. We do have a mixed approach here, with some repos like android-maps-utils adding headers, and compose not. I would still go for checking the header of what can be susceptible to falling under a copyright issue. Arguable, build files should not be a part of this.

@kikoso kikoso changed the title feat: added header checker chore: added header checker Dec 15, 2023
@wangela
Copy link
Member

wangela commented Dec 15, 2023

This should be merged as a chore:

wangela
wangela requested changes Dec 15, 2023
View reviewed changes
Copy link
Member

@wangela wangela left a comment

Choose a reason for hiding this comment

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

Add .gradle

wangela
wangela requested changes Jan 26, 2024
View reviewed changes
.github/header-checker-lint.yml
Copy link
Member

Choose a reason for hiding this comment

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

The header-check check is failing https://github.com/googlemaps/android-maps-utils/pull/1285/checks?check_run_id=20320966664

.github/header-checker-lint.yml should have a copyright year of 2024

Copy link
Member

Choose a reason for hiding this comment

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

Sorry this is my fault for taking so long to review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wangela wangela wangela requested changes

@amuramoto amuramoto Awaiting requested review from amuramoto amuramoto is a code owner automatically assigned from googlemaps/admin

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Header Check to android-maps-utils
2 participants
@kikoso @wangela