Skip to content

chore: added header checker#1285

Merged
dkhawk merged 4 commits into
mainfrom
feat/added_header_checker
Jun 20, 2024
Merged

chore: added header checker#1285
dkhawk merged 4 commits into
mainfrom
feat/added_header_checker

Conversation

@kikoso

@kikoso kikoso commented Dec 7, 2023

Copy link
Copy Markdown
Collaborator

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 review from a team and amuramoto December 7, 2023 14:06
@wangela

wangela commented Dec 9, 2023

Copy link
Copy Markdown
Member

Should we add .gradle files too?

@kikoso

kikoso commented Dec 15, 2023 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

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

wangela commented Dec 15, 2023

Copy link
Copy Markdown
Member

This should be merged as a chore:

wangela
wangela requested changes Dec 15, 2023
View reviewed changes

@wangela wangela left a comment

Copy link
Copy Markdown
Member

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
Comment thread .github/header-checker-lint.yml
@googlemaps-bot

googlemaps-bot commented Jun 20, 2024

Copy link
Copy Markdown
Contributor

Code Coverage

There is no coverage information present for the Files changed

Total Project Coverage 38.15% 🍏

@dkhawk dkhawk merged commit babd50c into main Jun 20, 2024
@dkhawk dkhawk deleted the feat/added_header_checker branch June 20, 2024 21:33
@googlemaps-bot

googlemaps-bot commented Oct 28, 2024

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Reviewers

@wangela wangela wangela requested changes

@dkhawk dkhawk dkhawk approved these changes

@amuramoto amuramoto Awaiting requested review from amuramoto

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Header Check to android-maps-utils

4 participants

@kikoso @wangela @googlemaps-bot @dkhawk