Skip to content

docs: revise third-party license tables in docs #329

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.

Sign up for GitHub

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
2bndy5 merged 1 commit into from
Jun 5, 2026
Merged

docs: revise third-party license tables in docs #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cpp-linter/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ thiserror = { workspace = true }
tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }

[dependencies.git-bot-feedback]
version = "0.5.4"
version = "0.5.5"
features = ["file-changes"]
# path = "../../git-bot-feedback"
# git = "https://github.com/2bndy5/git-bot-feedback"
Expand Down
18 changes: 5 additions & 13 deletions docs/license_gen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
[MIT]: https://choosealicense.com/licenses/mit
[Apache-2.0]: https://choosealicense.com/licenses/apache-2.0/
[MPL-2.0]: https://choosealicense.com/licenses/mpl-2.0
[GPL-3.0]: https://choosealicense.com/licenses/gpl-3.0/
"""

TABLE_HEADER = "| Dependency | License |\n|:------------|:-------|\n"
Expand All @@ -23,17 +24,6 @@
{TABLE_HEADER}\
"""

OPTIONAL_DEPS = f"""## Optional dependencies

The following are conditionally included in binaries (using the `openssl-vendored`
feature on a case-by-case basis) because it is a dependency of
[git2](https://crates.io/crates/git2):

{TABLE_HEADER}\
| [openssl](https://crates.io/crates/openssl) | [Apache-2.0] |
| [openssl-probe](https://crates.io/crates/openssl-probe) | [MIT] OR [Apache-2.0] |
"""

PY_BINDING_HEADER = f"""## Bindings' dependencies

### Python binding
Expand All @@ -44,7 +34,9 @@

{TABLE_HEADER}"""

SELF_DEP = re.compile(r"(\| \[cpp-linter v[0-9.]+[^\s]*)[^\]]+(\]\(.*)$")
SELF_DEP = re.compile(
r"(\| \[(?:cpp-linter|clang-installer) v[0-9.]+[^\s]*)[^\]]+(\]\(.*)$"
)


class TreeGetter:
Expand Down Expand Up @@ -80,6 +72,7 @@ def get_output(self) -> str:
.replace(" MIT", " [MIT]")
.replace(" Apache-2.0", " [Apache-2.0]")
.replace(" MPL-2.0", " [MPL-2.0]")
.replace(" GPL-3.0", " [GPL-3.0]")
.strip()
)
self_match = SELF_DEP.match(dep)
Expand All @@ -96,7 +89,6 @@ def get_output(self) -> str:
doc += tg.get_output()
# print(doc)
print(doc, file=io_doc)
print(f"\n{OPTIONAL_DEPS}\n", file=io_doc)
tg.package("cpp-linter-py")
doc = tg.get_output()
print(f"\n{PY_BINDING_HEADER}{doc}", file=io_doc)
Expand Down
Loading