Skip to content

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

Merged
2bndy5 merged 1 commit into
mainfrom
revise-docs-license-pg
Jun 5, 2026
Merged

docs: revise third-party license tables in docs#329
2bndy5 merged 1 commit into
mainfrom
revise-docs-license-pg

Conversation

@2bndy5
Copy link
Copy Markdown
Collaborator

@2bndy5 2bndy5 commented Jun 5, 2026

I had to bump git-bot-feedback so that its metadata uses a SPDX identifier (instead of a LICENSE file which is not a custom license).

I also removed the hard-coded table about OpenSSL now that we don't use it anymore.

Summary by CodeRabbit

  • Chores

    • Updated internal dependencies to latest versions
  • Documentation

    • Improved license documentation generation to include GPL-3.0 reference with proper link attribution
    • Simplified generated license documentation by removing optional dependencies section
    • Enhanced self-dependency detection for versioned package entries

I had to bump git-bot-feedback so that its metadata uses a SPDX identifier (instead of a custom LICENSE file).

I also removed the hard-coded table about OpenSSL now that we don't use it anymore.
@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Jun 5, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 326bdb3d-9bb5-4d8a-b2e8-dc7566c98364

📥 Commits

Reviewing files that changed from the base of the PR and between 0ca69c4 and a0765f4.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • cpp-linter/Cargo.toml
  • docs/license_gen.py

Walkthrough

The PR updates the git-bot-feedback dependency to version 0.5.5 and refactors the license generator to add GPL-3.0 license support, remove optional-dependencies handling, and recognize both cpp-linter and clang-installer in self-dependency detection with output normalization for GPL-3.0 link references.

Changes

Dependency and License Metadata Updates

Layer / File(s) Summary
Dependency version bump
cpp-linter/Cargo.toml
The git-bot-feedback dependency is updated from version 0.5.4 to 0.5.5.
License generator GPL-3.0 and optional dependencies update
docs/license_gen.py
License reference preamble adds GPL-3.0 URL; OPTIONAL_DEPS constant and its output emission are removed; SELF_DEP regex expands to match cpp-linter and clang-installer versioned entries; output normalization maps "GPL-3.0" to [GPL-3.0] link reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • cpp-linter/cpp-linter-rs#91: Both PRs modify docs/license_gen.py, specifically around the OPTIONAL_DEPS license/dependency table generation.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: revise third-party license tables in docs' is directly related to the main changes, which involve updating license references in docs/license_gen.py and bumping a dependency for proper SPDX identifier usage.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch revise-docs-license-pg

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.94%. Comparing base (0ca69c4) to head (a0765f4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #329   +/-   ##
=======================================
  Coverage   90.94%   90.94%           
=======================================
  Files          22       22           
  Lines        3368     3368           
=======================================
  Hits         3063     3063           
  Misses        305      305           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@2bndy5 2bndy5 merged commit 8e2fcad into main Jun 5, 2026
68 checks passed
@2bndy5 2bndy5 deleted the revise-docs-license-pg branch June 5, 2026 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant