...
| Code Block |
|---|
sbt headerCreateAll |
This will for example add the standard Apache header to the top of the source files but it will also handle other cases such as adding the Apache SPDX header to configuration files.
All of Pekko projects run the header check on every PR which in addition to protected branches + strict status check helps alleviate regressions in license headers, i.e. using core Pekko project as an example
...
| Info | ||||||||
|---|---|---|---|---|---|---|---|---|
Do note that while its possible to use other tools to check for headers (such as rat Apache Rat) its not recommend because all of the header requirements that resulted from legal discussions such as
On top of this, since Pekko projects use sbt as a build tool, sbt-header (which is an sbt plugin) is aware of the difference between generated sources (i.e. from templates/macros) which are NOT part of the source distribution and actual sources. Rat cannot tell the difference which means it may incorrectly mark files as needing headers if you didn't clean the project after building it. In short, Rat can provide both a lot of false positives and false negatives and although it can be configured to remediate some of these problems it won't solve all of them. |