Skip to content

Automate license headers #266

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

Merged
merged 4 commits into from
Feb 22, 2019
Merged

Automate license headers #266

merged 4 commits into from
Feb 22, 2019

Conversation

loganlinn
Copy link
Contributor

Adds the com.github.hierynomus.license Gradle plugin that will verify
all source files have license header when the check task runs (i.e. tests).

The plugin will handle adding headers to files that are missing it (i.e.
check failures) by running the licenseFormatMain or licenseFormatTest task,
depending on which source set the file belongs to.

See plugin documentation for more information.

Adds the [`com.github.hierynomus.license`][plugin] Gradle plugin that will
verify all source files have license header when the `check` task runs (i.e. tests).

The plugin automates adding headers to files that are missing it (i.e.
check failures) by running the `licenseFormatMain` or `licenseFormatTest`
task, depending on which source set the file belongs to.

See [plugin][] documentation for more information.

[plugin]: https://github.com/hierynomus/license-gradle-plugin
@loganlinn
Copy link
Contributor Author

The CI tests are expected to fail when first run as there are a few files missing header. Doing this to verify things are working properly then will add them in this PR

@loganlinn loganlinn marked this pull request as ready for review February 22, 2019 17:57
@coveralls
Copy link

Pull Request Test Coverage Report for Build 891

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.038%

Totals Coverage Status
Change from base Build 885: 0.0%
Covered Lines: 2648
Relevant Lines: 2974

💛 - Coveralls

Copy link
Contributor

@mikeproeng37 mikeproeng37 left a comment

Choose a reason for hiding this comment

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

Nice! This is way better than manually checking.

@loganlinn loganlinn merged commit 86c0af0 into master Feb 22, 2019
@loganlinn loganlinn deleted the llinn/gradle-license-plugin branch February 22, 2019 20:47
@alexsaves
Copy link

Love this! Great idea Logan

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.

4 participants