Skip to content

chore: add SPDX license headers to project-info.conf and paradox .htaccess - #1306

Merged
pjfanning merged 1 commit into
apache:mainfrom
pjfanning:license-headers-non-source-files
Sep 17, 2026
Merged

pjfanning merged 1 commit into
apache:mainfrom
pjfanning:license-headers-non-source-files

Conversation

@pjfanning

Copy link
Copy Markdown
Member

Motivation

A scan of the source tree for files without an Apache license header found two that sbt-header never sees: project/project-info.conf, which lives outside every source set, and docs/src/main/paradox/.htaccess, which has no sbt-header file type.

Mirrors apache/pekko#3545, which added headers to the logback XML files, shell scripts and benchmark template that sbt-header misses in pekko. pekko-http has no logback configs, its one shell script already carries a header and its boilerplate templates are covered by the *.scala.template mapping in CopyrightHeader, so only these two files remain.

Modification

Prepend the # SPDX-License-Identifier: Apache-2.0 line that CopyrightHeader.hashLineComment hardcodes for every hash-comment file in this repo, matching the header on the reference.conf and application.conf files and on pekko's own project-info.conf.

Result

Every tracked configuration and script file carries a license header. No behavior change: HOCON and Apache httpd both treat # lines as comments.

Tests

  • project/project-info.conf parsed and resolved with Typesafe Config 1.4.6 after the change; project-info.scaladoc resolves as before.
  • sbt headerCheckAll - pass.

References

None - follows apache/pekko#3545

…ccess

Motivation:
A scan of the source tree for files without an Apache license header
found two that sbt-header never sees: `project/project-info.conf`,
which lives outside every source set, and
`docs/src/main/paradox/.htaccess`, which has no sbt-header file type.
Mirrors apache/pekko#3545, which added headers to the logback XML
files, shell scripts and benchmark template that sbt-header misses in
pekko. pekko-http has no logback configs, its one shell script already
carries a header and its boilerplate templates are covered by the
`*.scala.template` mapping in `CopyrightHeader`, so only these two
files remain.

Modification:
Prepend the `# SPDX-License-Identifier: Apache-2.0` line that
`CopyrightHeader.hashLineComment` hardcodes for every hash-comment file
in this repo, matching the header on the `reference.conf` and
`application.conf` files and on pekko's own `project-info.conf`.

Result:
Every tracked configuration and script file carries a license header.
No behavior change: HOCON and Apache httpd both treat `#` lines as
comments.

Tests:
- `project/project-info.conf` parsed and resolved with Typesafe Config
  1.4.6 after the change; `project-info.scaladoc` resolves as before.
- sbt headerCheckAll - pass.

References:
None - follows apache/pekko#3545
@pjfanning
pjfanning merged commit d9a5eb1 into apache:main Sep 17, 2026
6 checks passed
@pjfanning
pjfanning deleted the license-headers-non-source-files branch September 17, 2026 19:12
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