Skip to content

fix: deliver package licenses and required notices - #1133

Merged
nabinchha merged 2 commits into
feat/slurm-executionfrom
codex/osrb-review-corrections
Nov 6, 2026
Merged

nabinchha merged 2 commits into
feat/slurm-executionfrom
codex/osrb-review-corrections

Conversation

@nabinchha

@nabinchha nabinchha commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

📋 Summary

Ensure all four published packages include the complete Apache license text and NVIDIA copyright notice. Complete contributor sign-off instructions, source headers, and external-material notices while preserving tutorial notebook metadata.

🔗 Related Issue

N/A — package licensing and contribution-documentation corrections.

🔄 Changes

  • Synchronize the root and four package license files, explicitly declare packaged license files, and explain the independently distributed Slurm copy in README.
  • Add per-commit DCO sign-off instructions, command and trailer examples, the existing first-time-contributor bot signature step, and the complete unchanged certification to both contribution guides.
  • Add missing notices to Makefile, six tutorial sources, their tracked Colab outputs, and the local-preview stylesheet. Preserve Jupytext front matter when maintaining headers, including in empty notebooks.
  • Add the full external-materials notice to README and the published installation page, and clarify the scope of license checks for separately distributed bundles and containers.
  • Extend the package-install CI check to build all wheels and source archives and verify complete license text plus metadata. Add regression tests for license delivery and notebook-safe header updates.

🔍 Attention Areas

The bundled ZIP-to-area-code asset is unchanged. Confirming its original source and applicable redistribution terms remains a separate follow-up; this PR does not resolve that provenance item.

🧪 Testing

  • Focused documentation and package-license suites: 84 passed, 2 skipped.
  • All four wheels and four source archives contain the canonical license and correct license metadata; strict Twine validation passed for all eight artifacts.
  • Full package-install CI script: base install, Slurm extra, direct Slurm install, CLI discovery, and startup-time checks passed.
  • All six tutorials preserve existing cells and metadata and retain notices through Jupytext, Colab, and Fern conversion. Tracked Colab outputs match fresh generation, ignoring random cell IDs.
  • Header check: 869 files, no updates needed. Changed-source lint/format and whitespace checks passed.
  • Fern validation: zero errors and one authentication warning for redirects; internal links passed across 101 pages.
  • Full application suite: not rerun; changes are limited to packaging, maintenance scripts, and documentation.

✅ Checklist

  • Follows commit message conventions
  • Commits are signed off (DCO)
  • Published contribution and installation documentation updated
  • External-contributor triage requirement: N/A — repository collaborator.
  • Architecture docs: N/A — package layering and runtime architecture are unchanged.

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Fern preview: https://nvidia-preview-pr-1133.docs.buildwithfern.com/nemo/datadesigner

Fern previews include the docs-website version archive with PR changes synced into latest. Notebook tutorials are rendered without execution outputs in previews.

@andreatnvidia andreatnvidia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @nabinchha for covering the package licenses, notices, and DCO updates. Requesting changes to sync the generated Colab notebooks before this reaches main. There’s also a smaller, non-blocking correction to the DCO instructions.

Comment on lines +15 to +16
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[P2] Sync the generated Colab notebooks

These headers create an extra Jupytext cell in all six tutorials, but the tracked Colab notebooks are unchanged and omit the notices. Please run make generate-colab-notebooks and commit the updated outputs. The notebook-sync check only runs against main, so it hasn’t caught the mismatch on this PR’s Slurm base branch.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 1f2802f. Ran make generate-colab-notebooks and committed all six regenerated Colab notebooks. Verified that each tracked output matches fresh generation when ignoring random cell IDs and contains the license notice; unchanged cell IDs were retained to reduce diff noise. The focused documentation/package-license suites passed: 84 tests, 2 skips.

Comment thread CONTRIBUTING.md
Comment on lines +124 to +129
Every commit in a contribution must include a `Signed-off-by` trailer. By signing off, you certify that you have the right to submit the contribution under the project's open source license, as set out in the Developer Certificate of Origin (DCO) below.

Add your sign-off with `git commit -s`:

```bash
git commit -s -m "describe your change"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[P3] Keep the DCO bot-signing step documented

Could we retain the bot-signing instructions alongside git commit -s in both contribution guides? The existing workflow still requires a first-time contributor’s PR-comment signature, so following these instructions alone won’t satisfy the DCO check. This is non-blocking, but documenting both steps would avoid confusion.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 1f2802f. Both contribution guides now document the first-time DCO Assistant signature alongside the per-commit git commit -s requirement, including the exact PR-comment phrase configured in the workflow and the recheck command. The full DCO certification remains unchanged. Fern validation and internal-link checks passed.

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>
@nabinchha
nabinchha marked this pull request as ready for review November 6, 2026 17:19
@nabinchha
nabinchha requested a review from a team as a code owner November 6, 2026 17:19
@greptile-apps

greptile-apps Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] This PR appears safe to merge.

Summary

This PR adds complete license copies to the published packages and checks their contents in wheels and source archives.

  • Each published package carries the full Apache license with its release.
  • The contribution guides show how to sign off every commit.
  • The published docs explain the terms around external materials and separate bundles.
  • Tutorial notebook settings stay in place when license headers are added.

nabinchha explicitly deferred the unchanged ZIP-to-area-code asset’s source and redistribution terms. This review does not treat that item as resolved.

Reviews (1) · Last reviewed commit: "docs: sync notebook notices and DCO sign..." · Reviewed by Greptile

@nabinchha
nabinchha merged commit 0391205 into feat/slurm-execution Nov 6, 2026
13 checks passed
@nabinchha
nabinchha deleted the codex/osrb-review-corrections branch November 6, 2026 17:32
nabinchha added a commit that referenced this pull request Nov 6, 2026
* fix: deliver package licenses and required notices

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>

* docs: sync notebook notices and DCO signing

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>

---------

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>
andreatnvidia pushed a commit that referenced this pull request Nov 9, 2026
* fix: deliver package licenses and required notices

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>

* docs: sync notebook notices and DCO signing

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>

---------

Signed-off-by: Nabin Mulepati <nmulepati@nvidia.com>
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