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

Refactor check-header script #1289

Merged
merged 1 commit into from Mar 22, 2024
Merged

Refactor check-header script #1289

merged 1 commit into from Mar 22, 2024

Conversation

tortmayr
Copy link
Contributor

What it does

Refactor check header script to only consider the endYear in copyrigh headers. Previously we also had a mechanism in place to validate the start year of a copyright range. However, this approach was flawed because

  • It could not consider files that predate the initial inception of the repository
  • had a hard time with determining the correct start year for files that have been renamed/moved

So in the end we opted for ignoring startYear validations anyways and only considered endYear errors. Therefore this PR removes the entire startYear validation and we only check for single year or end year violations. This makes the whole check process faster and less error prone.

In addition, there was an issue with files that had multiple copyright years defined (e.g. contribution-provider in glsp-client). This is now fixed.

In addition, align version numbers with the other GLSP projects so that the dev-packages can be included in the Release train.

Also: Minor fix for release-vscode-integration

How to test

Follow-ups

Changelog

  • This PR should be mentioned in the changelog
  • This PR introduces a breaking change (if yes, provide more details below for the changelog and the migration guide)

Refactor check header script to only consider the `endYear` in copyrigh headers.
Previously we also had a mechanism in place to validate the start year of a copyright range.
However, this approach was flawed because
- It could not consider files that predate the initial inception of the repository
- had a hard time with determining  the correct start year for files that have been renamed/moved

So in the end we opted for ignoring startYear validations anyways and only considered endYear errors.
Therefore this PR removes the entire `startYear` validation and we only check for single year or end year violations.
This makes the whole check process faster and less error prone.

In addition, there was an issue with files that had multiple copyright years defined (e.g. `contribution-provider` in glsp-client). This is now fixed.

In addition, align version numbers with the other GLSP projects so that the dev-packages can be included in the Release train.

Also: Minor fix for `release-vscode-integration`
Copy link
Contributor

@martin-fleck-at martin-fleck-at left a comment

Choose a reason for hiding this comment

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

LGTM!

@tortmayr tortmayr merged commit 886d2d0 into master Mar 22, 2024
5 checks passed
@tortmayr tortmayr deleted the fix-headers branch March 22, 2024 06:52
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.

None yet

2 participants