Skip to content

chore(docs): update openshell release note with "early access" - #1260

Merged
maxdubrinsky merged 1 commit into
mainfrom
md/update-openshell-release-docs
Aug 12, 2026
Merged

chore(docs): update openshell release note with "early access"#1260
maxdubrinsky merged 1 commit into
mainfrom
md/update-openshell-release-docs

Conversation

@maxdubrinsky

@maxdubrinsky maxdubrinsky commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Make clear the early-access nature of the openshell sandbox integration we have.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Summary by CodeRabbit

  • Documentation
    • Updated release notes to describe early-access agent deployment through an Openshell Gateway.
    • Clarified that deployments support customizable default-deny network policies.
    • Replaced broader sandbox backend terminology with more specific deployment details.
    • Added clearer guidance about the deployment approach and its network-policy configuration.

@maxdubrinsky
maxdubrinsky requested review from a team as code owners August 12, 2026 18:13
@github-actions github-actions Bot added the chore label Aug 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 75d7be7b-9260-4a71-af7f-de270b6e5c7a

📥 Commits

Reviewing files that changed from the base of the PR and between d155bc9 and 980446d.

📒 Files selected for processing (3)
  • docs/about/release-notes/current-release.mdx
  • plugins/nemo-deployments/tests/unit/backends/docker/docker_helpers.py
  • plugins/nemo-deployments/tests/unit/backends/docker/test_backend_mocked.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/about/release-notes/current-release.mdx

📝 Walkthrough

Walkthrough

The release note now describes early-access Openshell Gateway deployment with customizable default-deny network policies. Docker backend tests now cover config file archive delivery, startup ordering, file modes, no-file behavior, and delivery failures.

Changes

Docker config file coverage

Layer / File(s) Summary
Define config file deployment fixtures
plugins/nemo-deployments/tests/unit/backends/docker/docker_helpers.py, plugins/nemo-deployments/tests/unit/backends/docker/test_backend_mocked.py
The tests add a ConfigFile fixture with configurable path, content, and restart policy.
Validate archive delivery and startup handling
plugins/nemo-deployments/tests/unit/backends/docker/test_backend_mocked.py
The tests verify archive contents, parent directories, file modes, startup ordering, no-file behavior, and cleanup after delivery failures.

Release note update

Layer / File(s) Summary
Update deployment capability description
docs/about/release-notes/current-release.mdx
The deployment note now describes early-access Openshell Gateway deployment and customizable default-deny network policies.

Possibly related PRs

Suggested labels: docs

Suggested reviewers: briannewsom, mckornfield, stefan-kickoff

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the release-note update but omits the main Docker config-file deployment and test changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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 md/update-openshell-release-docs

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

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/about/release-notes/current-release.mdx`:
- Around line 121-122: Update the release-note text to capitalize the product
name as “OpenShell” instead of “Openshell,” without changing the surrounding
description.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a5938e19-81a6-4773-80b3-a3b122403d15

📥 Commits

Reviewing files that changed from the base of the PR and between d4b8171 and d155bc9.

📒 Files selected for processing (1)
  • docs/about/release-notes/current-release.mdx

Comment thread docs/about/release-notes/current-release.mdx Outdated
Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
@maxdubrinsky
maxdubrinsky force-pushed the md/update-openshell-release-docs branch from d155bc9 to 980446d Compare August 12, 2026 18:18
@github-actions

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 32015/40717 78.6% 63.4%
Integration Tests 18566/38643 48.0% 20.8%

@maxdubrinsky
maxdubrinsky added this pull request to the merge queue Aug 12, 2026
Merged via the queue into main with commit 6249417 Aug 12, 2026
59 checks passed
@maxdubrinsky
maxdubrinsky deleted the md/update-openshell-release-docs branch August 12, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants