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

Configure hawkeye to update license headers #38

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

Conversation

KushalP
Copy link
Contributor

@KushalP KushalP commented Feb 3, 2025

You can test this with:

hawkeye check --fail-if-unknown

You can update header comments with:

hawkeye format --fail-if-unknown

Ref: https://github.com/korandoru/hawkeye/

@KushalP

This comment was marked as outdated.

Copy link
Contributor

@bioball bioball left a comment

Choose a reason for hiding this comment

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

Some comments:

  • This script should add the license header if one is missing (with the current year as the copyright year).
  • It should allow for different copyright formats (some copyrights use block comments, others use line comments).
  • It should fetch from origin/main prior to execution, and the remote name should be changed if the env var PKL_ORIGINAL_REMOTE_NAME is set.
  • It should accept a set of filenames (we want to format .swift and .pkl files in this repo). It should also allow for a set of files to be excluded (we want to ignore generated `.pkl.swift files), for example.

@KushalP

This comment was marked as outdated.

@KushalP KushalP changed the title Provide a way to check license headers for correctness Configure hawkeye to update license headers Feb 11, 2025
You can test this with:

```
hawkeye check --fail-if-unknown
```

You can update header comments with:

```
hawkeye format --fail-if-unknown
```

Ref: https://github.com/korandoru/hawkeye/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants