You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@resilientdb.apache.org by "Toby1009 (via GitHub)" <gi...@apache.org> on 2026/07/23 09:19:35 UTC
[PR] Render the ASF license header in Markdown files as a comment [incubator-resilientdb]
Toby1009 opened a new pull request, #265:
URL: https://github.com/apache/incubator-resilientdb/pull/265
## The problem
Commit 709b3a48 stamped the ASF license header into 43 Markdown files using
the shell-comment form:
```
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. ...
```
In Markdown a leading `#` is a heading, so GitHub renders each of these files
with the full license text as eighteen lines of top-level headings before the
actual content — see for example
[ecosystem/sdk/resvault-sdk](https://github.com/apache/incubator-resilientdb/tree/master/ecosystem/sdk/resvault-sdk)
on master. This affects almost every README under `ecosystem/`, plus
`CHANGELOG.md`, `CODE_OF_CONDUCT.md`, `INSTALL/README.md` and several
`platform/` and `service/` READMEs.
There were three variants: 38 files with the bare `#` block (renders as
headings), one file wrapping it in a ```` ```text ```` fence (renders the
header as a visible code block), and four files that already had `<!-- -->`
around it but kept the stray `#` markers inside.
## The change
All 43 files now use the HTML-comment form that the root `README.md` already
uses, which renders as nothing. The header text is byte-identical to the root
README's; no wording changes.
A second commit fixes three READMEs that linked to a `LICENSE` file in their
own directory that does not exist there (the link 404s on GitHub); they now
point at the repository root `LICENSE`. One of them
(`ecosystem/smart-contract/rescontract`) also still said the project is under
the MIT License, which predates the donation — the file itself carries the ASF
header and the repository is Apache-2.0, so the sentence now says that.
## Verification
- No Markdown file matches `^# Licensed to the Apache` any more, and every
rewritten header is byte-identical to the root README's block.
- Every diff hunk is confined to the header block plus the three license-link
lines; content is otherwise untouched.
- `dev/check-license` (Apache RAT 0.16.1) reports exactly the same result on
this branch as on master — the same 49 pre-existing files without headers
(`Security.md`, the `.mdx` files, …), nothing added.
- license-eye — the skywalking-eyes check that `license.yml` runs on every
pull request — was run locally with the official image against both this
branch and master: identical results. All 43 rewritten headers are accepted.
The one committed file it flags, `Security.md`, is flagged on master too and
is untouched here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@resilientdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Render the ASF license header in Markdown files as a comment [incubator-resilientdb]
Posted by "cjcchen (via GitHub)" <gi...@apache.org>.
cjcchen commented on PR #265:
URL: https://github.com/apache/incubator-resilientdb/pull/265#issuecomment-5229462413
please fix the license issue
https://github.com/apache/incubator-resilientdb/actions/runs/29994801183/job/93188218084?pr=265
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@resilientdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Render the ASF license header in Markdown files as a comment [incubator-resilientdb]
Posted by "Toby1009 (via GitHub)" <gi...@apache.org>.
Toby1009 commented on PR #265:
URL: https://github.com/apache/incubator-resilientdb/pull/265#issuecomment-5229708518
Rebased onto master to pick up the Security.md license header fix from #254. The earlier license failure came from that file, not from this PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@resilientdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Render the ASF license header in Markdown files as a comment [incubator-resilientdb]
Posted by "cjcchen (via GitHub)" <gi...@apache.org>.
cjcchen merged PR #265:
URL: https://github.com/apache/incubator-resilientdb/pull/265
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@resilientdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org