Skip to content

build(helm): include license in chart package - #359

Open
saturley-hall wants to merge 1 commit into
mainfrom
harrison/osrb-helm-license
Open

saturley-hall wants to merge 1 commit into
mainfrom
harrison/osrb-helm-license

Conversation

@saturley-hall

@saturley-hall saturley-hall commented Sep 17, 2026

Copy link
Copy Markdown
Member

What type of PR is this?

  • cleanup
  • documentation

What this PR does / why we need it:

Adds a relative charts/snapshot/LICENSE symlink to the repository-level Apache-2.0 license and documents that it exists only for packaging. Helm dereferences the link into a regular file in the published chart archive.

Which issue(s) this PR fixes:

Fixes #358

How was this tested?

  • make verify-crds verify-license-headers helm-lint verify-toc
  • packaged the chart and verified snapshot/LICENSE is a regular file byte-identical to the repository LICENSE
  • git diff --check

Special notes for your reviewer:

The full make check reached pagebroker-check-generated but could not execute the repository-bootstrapped protoc binary on macOS arm64. The targeted checks relevant to this change pass.

Does this PR introduce an API change?

NONE

Additional documentation, e.g. enhancement proposals, usage docs:

The root README now explains the chart-local packaging symlink.

Checklist

  • Commits are signed off (git commit -s), per CONTRIBUTING.md
  • make check test passes locally
  • Documentation is updated where behavior changed

Summary by CodeRabbit

  • Documentation
    • Added a License section note clarifying how the chart license is included in packaged chart archives.
    • Documented that the chart’s license references the project’s top-level license, ensuring licensing information remains available as a regular file in archive outputs.

Signed-off-by: Harrison King Saturley-Hall <hsaturleyhal@nvidia.com>
@saturley-hall
saturley-hall requested a review from a team as a code owner September 17, 2026 23:38
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 6157919f-c017-45d8-a2fd-fe0707903f1c

📥 Commits

Reviewing files that changed from the base of the PR and between fdd5bd8 and 6ab2f20.

📒 Files selected for processing (2)
  • README.md
  • charts/snapshot/LICENSE

Included review availability: Your plan provides up to 12 included reviews per hour; 8 remain after this review.


Walkthrough

The chart adds a relative LICENSE symlink to the repository license. The README documents that Helm packages the symlink target as a regular file.

Changes

License packaging

Layer / File(s) Summary
Chart license link and packaging documentation
charts/snapshot/LICENSE, README.md
Adds a relative symlink from charts/snapshot/LICENSE to the top-level LICENSE. Documents the symlink and Helm packaging behavior.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 6ab2f

The chart license link and packaging documentation align with the stated change, with no actionable merge risk identified.

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title accurately describes the Helm chart packaging change and is under 72 characters, but build is not an allowed Conventional Commit type. Change the prefix to an allowed type, such as chore(helm): include license in chart package.
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The pull request satisfies all coding requirements in issue #358. charts/snapshot/LICENSE is a relative symlink to ../../LICENSE. The summary reports chart packaging verification for a regular `sn…
Out of Scope Changes check ✅ Passed The changes stay within issue #358. They add the required chart license symlink and the required root README explanation. No unrelated source, API, permission, or runtime changes are reported.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Breaking Api Changes ✅ Passed The reviewed range changes only README.md and adds the charts/snapshot/LICENSE symlink. The authoritative diff has no changes under api/**, so it removes, renames, or changes no exported fields, JSON …
Rbac Least Privilege ✅ Passed PASS. The pull request changes only README.md and adds the charts/snapshot/LICENSE symlink. No kubebuilder RBAC marker or Helm RBAC manifest changes are present. Existing RBAC markers and chart RB…
  • Fix all pre-merge checks with AI

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

Comment thread README.md
Comment on lines +231 to +233
The `charts/snapshot/LICENSE` entry is a symbolic link to that top-level file. It exists only so
Helm includes the license when packaging the chart; Helm dereferences the link and writes a
regular-file copy into the chart archive.

@ozbarshalom ozbarshalom Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to explain that in the README?

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.

Include the Apache-2.0 license in the packaged Helm chart

2 participants