Skip to content

docs: remove the Public Preview label from docs, metadata and code - #4407

Open
MohammadHaroonAbuomar wants to merge 7 commits into
mainfrom
mhabuomar/issue-4373
Open

MohammadHaroonAbuomar wants to merge 7 commits into
mainfrom
mhabuomar/issue-4373

Conversation

@MohammadHaroonAbuomar

Copy link
Copy Markdown
Collaborator

Related Issue

Fixes #4373

Problem & Solution

The README, the roadmap, 22 package manifests, 20 package READMEs and docs pages, and about 60 source and test files carried a "Public Preview" label. That is a product release stage. This repository is an MIT open-source project, not a product release, so the label does not apply, and it raised questions it could not answer (discussion #4326 asked for a GA date). Semver and BREAKING_CHANGES.md already say how API changes are handled.

This PR removes the label everywhere it described the project's or a feature's stage:

  • README.md (and the Spanish and Korean READMEs) lose the banner; docs/ROADMAP.md now says "Current Release: v5.0.0 (2026-06-25)", which matches the tag and the CHANGELOG entry; the present-tense banner at the top of CHANGELOG.md is removed.
  • Package metadata: the "Public Preview — " prefix is dropped from descriptions in 13 package.json, 5 pyproject.toml, 2 Cargo.toml, 2 .csproj files and the Antigravity extension manifest. No classifier carried the label, so none changed.
  • Package READMEs and docs: stage-only blockquotes ("APIs may change before GA") are removed; headings and admonitions keep their factual content; the copilot-instructions rule that required the prefix is removed.
  • Source and tests: "Public Preview — basic implementation" header comments and docstrings in agent-hypervisor, agent-os, agent-sre become plain descriptions; 23 pytest skip reasons read "Feature not implemented". No statement, import, constant or assertion changed. Two stale statements were corrected on the way: the hash-chain test docstring and the EU AI Act checklist item that quoted a "no chain verification" comment, since verify_chain() now checks hashes and parent linkage.
  • A new Quality Gates job runs scripts/ci/check_no_public_preview.sh, which fails if the phrase returns outside the dated history.

Kept as dated history: the 3.0.0 CHANGELOG entry, the BREAKING_CHANGES.md note that recorded why 5.0.0 could remove the hypervisor stubs, the shipped release notes under docs/releases, and four dated dependency-audit records. The guard allows those paths.

A short note under docs/security/audits is included because the security-audit gate fires on any change under agent_os/mcp_gateway.py; only that module's docstring title changed.

Impact on Your Work

None at runtime. Package descriptions on the registries lose the prefix on the next publish.

Timeline

None.

Alternatives Considered

Keeping the label with a definition of what it means. Rejected: the project is not on a product release track, and a definition would still invite the GA question.

Type of Change

  • Documentation update
  • Code change (comments, docstrings and skip reasons only; no behaviour change)

Package(s) Affected

  • agent-os
  • agent-hypervisor
  • agent-sre
  • agent-mesh (README and docs only)
  • policy-engine (Cargo.toml descriptions)
  • agent-governance-dotnet (.csproj descriptions)
  • CLI and extension packages (package.json descriptions)
  • docs / root

Testing

Run from the branch in a CI-like venv (editable core, integrations, CLI, protocols, agt-policies, native ACS SDK built with maturin):

  • agent-hypervisor pytest tests/: 663 passed, 23 skipped
  • agent-sre pytest tests/: 1595 passed
  • agent-mesh pytest tests/: 4510 passed, 81 skipped
  • agent-os pytest tests/: 3737 passed, 44 skipped
  • ruff check (E, F, W; E501 ignored) on all touched Python files: same findings as main, none new
  • python3 scripts/check_v4_ratchet.py: OK
  • Spell check on added lines (scripts/ci/changed_lines.py + cspell 8.17.3): 0 issues
  • scripts/ci/check_no_public_preview.sh: passes on the branch, fails on main
  • Existing gates against main: no-stubs, no-custom-crypto, security-audit-required, no-unauthed-registration, vendored-patch-audit all pass
  • All 22 edited manifests parse (json, tomllib, ElementTree)

An independent verification pass re-ran the agent-hypervisor and agent-sre suites on main and on the branch with identical results, confirmed every Python hunk touches only comments, docstrings or skip reasons, and listed every remaining mention of the phrase against the rule above.

Checklist

  • My code follows the project style guidelines
  • All new and existing tests pass
  • I have updated documentation as needed (CHANGELOG)
  • I have signed the Microsoft CLA

Attribution

  • This contribution does not contain code copied or derived from other projects without attribution

AI Assistance

  • I can explain every meaningful change in this PR: what it does, why, and what tradeoffs were considered
  • I have run tests and verification appropriate for this change
  • No part of this PR was autonomously submitted by an AI agent without my review
  • I have not used AI to generate review comments on others' PRs

Claude Code drafted the sweep under my direction; an independent verification pass re-checked every remaining mention, re-ran the package tests and the new guard, and I reviewed the result.

IP

  • This contribution does not implement patent-pending or patent-encumbered techniques
  • This contribution does not require an NDA or licensing agreement to understand or use

"Public Preview" is a product release stage. This repository is an
MIT-licensed open-source project, not a product release, so the label
does not apply and raised questions it could not answer (discussion
#4326 asked for a GA date). Semver and BREAKING_CHANGES.md already say
how API changes are handled.

Remove the banner from README.md, the Spanish and Korean READMEs and
the top of CHANGELOG.md, and update the roadmap's current-release line
from v3.7.0 to v5.0.0, released 2026-06-25 per CHANGELOG.md and the
v5.0.0 tag.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
Drop the "Public Preview" prefix from package descriptions in
package.json, pyproject.toml, Cargo.toml, .csproj and the Antigravity
extension manifest, and from package README headings and banners. The
label named a product release stage that does not apply to an MIT
open-source project. Sentences whose only content was the preview stage
("APIs may change before GA") are removed; factual notes such as the
Agent Learning version target stay.

Also drop the matching rule from .github/copilot-instructions.md and
the "Public Preview" kicker on the docs landing page, and correct the
JetBrains build comment: "IC" is IntelliJ IDEA Community.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
Remove the "Public Preview" stage label from module headers, docstrings
and comments in agent-hypervisor, agent-mesh, agent-os (including the
caas and emk modules) and agent-sre, from pytest skip reasons, and from
the specs, tutorials and compliance docs that describe current
behaviour. Where a sentence said a feature is incomplete, the factual
part stays ("half-open recovery is not implemented", "elevation
requests are always denied") and only the label goes.

No behaviour or test assertion changes. No test asserted on the literal
string; the skip reasons now read "Feature not implemented". The
test_hash_chain_integrity docstring and the EU AI Act checklist item
that quoted a removed "no chain verification" comment are brought in
line with verify_chain(), which checks hashes and parent linkage.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
scripts/ci/check_no_public_preview.sh fails when "public preview"
appears in any tracked file outside the dated release history
(CHANGELOG.md, BREAKING_CHANGES.md, docs/releases/). It runs from the
repository root and prints each offending line.

The script is not wired into quality-gates.yml here: that workflow is
hand-written rather than generated from .github/ci/workflows.toml, so
the PR notes the one job to add instead of editing it in this change.

Also add the security audit note the existing gate requires because
the module docstring of agent_os/mcp_gateway.py changed; the note
records that no behaviour changed.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
Wire scripts/ci/check_no_public_preview.sh into the hand-written
quality-gates.yml so the gate is enforced, widen its pattern to the
hyphenated form and allow the dated dependency-audit records, and
tighten the audit note to what was verified.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file tests agent-mesh agent-mesh package agent-hypervisor agent-hypervisor package agent-sre agent-sre package labels Oct 21, 2026
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions

Copy link
Copy Markdown

PR Review Summary

Check Status Details
🔍 Code Review ⚠️ Missing No current-run comment
🛡️ Security Scan ⚠️ Missing No current-run comment
🔄 Breaking Changes ⚠️ Missing No current-run comment
📝 Docs Sync ⚠️ Missing No current-run comment
🧪 Test Coverage ⚠️ Missing No current-run comment

Verdict: ⚠️ AI review incomplete; ready for human review

AI review comments are untrusted advisory output. The summary reports workflow-generated completion status only, not model-authored pass/fail claims.

@github-actions

Copy link
Copy Markdown

📦 Dependency diff (SBOM)

Comparing main → mhabuomar/issue-4373.

✅ No dependency changes detected.

deepwiki.com answers the link checker with 429 and
digital-strategy.ec.europa.eu with 403, so any PR that touches a page
linking to them fails the check regardless of the change. Both links
are valid in a browser. Add them to the ignore list.

Refs #4373

Signed-off-by: MohammadHaroonAbuomar <40180927+MohammadHaroonAbuomar@users.noreply.github.com>
@github-actions github-actions Bot added size/XL Extra large PR (500+ lines) size/L Large PR (< 500 lines) and removed size/L Large PR (< 500 lines) size/XL Extra large PR (500+ lines) labels Oct 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-hypervisor agent-hypervisor package agent-mesh agent-mesh package agent-sre agent-sre package dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation integration/adk-agentmesh integration/copilot-governance integration/mastra-agentmesh scripts/ci/cd security Security-related issues size/L Large PR (< 500 lines) tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove the Public Preview label from documentation and code

1 participant