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

header-lint for ts or js files #5

Closed
maany opened this issue Mar 9, 2022 · 3 comments
Closed

header-lint for ts or js files #5

maany opened this issue Mar 9, 2022 · 3 comments
Assignees
Labels
DevOps Building, Testing/CI and Releasing of Rucio UI Testing Unit Tests, Integration Tests

Comments

@maany
Copy link
Member

maany commented Mar 9, 2022

Motivation

The rucio\rucio repository uses header-lint script to ensure consistent headers across all source files. We could use the same script or something similar here as well.

Modification

  1. Add header-lint script from rucio/rucio.
  2. update the pre-commit hooks to include header-linting
  3. add the header-lint step in the autotest workflow
@maany maany added DevOps Building, Testing/CI and Releasing of Rucio UI Testing Unit Tests, Integration Tests labels Mar 9, 2022
@joeldierkes
Copy link
Contributor

The header lint script gives me a big headache. While I like the idea of explicitly listing all contributors to a source file, the header lint generates a lot of noise in the commits. They make the actual changes harder to read and pollute the history. The logic is, at the same time, fairly complex and not easy to implement. We still have multiple problems with the original header lint script.

There are sophisticated git tools to list the contributors of a file, they should be used instead.

We could create a script to add a generic Copyright information to the files, however I would strongly avoid to insert the contributors.

@maany
Copy link
Member Author

maany commented Jun 8, 2022

Hey @joeldierkes, seeing the fate of header-lint in the main rucio repo, I agree with you. Would you have time to add a script to add copyright notice to the files changed in a PR. :)

@maany maany added this to the 1.0.0 milestone Jun 8, 2022
@maany
Copy link
Member Author

maany commented Sep 5, 2022

bump @joeldierkes

@maany maany removed this from the 1.0.0 milestone Dec 7, 2022
@maany maany closed this as completed Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevOps Building, Testing/CI and Releasing of Rucio UI Testing Unit Tests, Integration Tests
Projects
None yet
Development

No branches or pull requests

2 participants