Repository navigation
doc: state that documentation-only dev pushes publish no packages - #485
Merged
Pedro Henrique Penna (ppenna) merged 1 commit intoOct 11, 2026
Merged
Conversation
The distribution guide said that every dev push stages and archives the three platform packages. The platform jobs run only when change classification selects the workload suites, so a documentation-only push skips them and gets no development release; download then falls back to the nearest released first-parent ancestor. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Pedro Henrique Penna (ppenna)
added
the
documentation
Copilot started reviewing on behalf of
Pedro Henrique Penna (ppenna)
October 11, 2026 17:09
View session
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation accurately matches CI classification, platform-job conditions, and download fallback behavior.
0 open findings
What changed in this PR
Clarifies development-release behavior for documentation-only dev pushes.
Changes:
- Documents that documentation-only pushes skip platform packaging and releases.
- Explains
downloadfalls back to the nearest released first-parent ancestor.
| File | Description |
|---|---|
doc/distribution.md |
Corrects release archive and fallback documentation. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pedro Henrique Penna (ppenna)
deleted the
doc-sync/distribution-docs-only-push
branch
October 11, 2026 17:13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
doc/distribution.mdsaid that everydevpush stages and archives the three platform packages. That is wrong for documentation-only pushes: the platform jobs run only when change classification selects the workload suites, so a push whose changed paths are all underdoc/or end in.mdproduces no packages and no development release. This PR corrects that paragraph and states the consequence fordownload.Changes
doc/distribution.md, Release archives: limit the CI packaging statement todevpushes that change more than documentation, and add that a documentation-only push skips the platform jobs (linking Change classification), gets no development release, and leavesdownloadto install the nearest released first-parent ancestor's package..github/workflows/ci.ymlrunsplatform-kvm,platform-mshv, andplatform-whponly whenneeds.openvmm-changes.outputs.run-workloads == 'true'(or classification did not succeed), andPublish development releaserequires all three to succeed..github/workflows/run-platform.ymlpackages only ondevpushes withpackage-release.doc/ci.md#change-classificationstates thatrun-workloadsis false only for documentation-only changes.Build shared artifacts, all threePlatform / ...jobs, andPublish development releaseskipped.gh release listshows nov0.1.0-dev.<sha>release for the documentation-only merges of doc: list the kernel configuration checks in the build guide #480, doc: state that verify skips the no-module kernel check #481, doc: add the managed sandbox lifecycle to the responsibility map #482, and doc: list the benchmark host telemetry module in the source tree #484, while code merges (e.g. ci: classify both rename paths and unquoted filenames #483 →v0.1.0-dev.ce4472653a54) have one.download's fallback:scripts/nvx_tools/release.py(download_checkout_release) anddoc/usage.md#download.No design documents changed, so no OpenVMM SHA applies. The base is
devat c29f3d1 (OpenVMM pin2130f24b5a51561cc6224fe5a0aff93cb121ac32).Follow-ups (out of scope)
doc/usage.md#downloadsays CI publishes a development release "for eachdevcommit whose checks pass". Documentation-only commits pass their checks but get no release. I left this out because open PRs test-microvm: pause and resume a microVM through OpenVMM state control #405 and Adopt bind-once microVM image slots #406 changedoc/usage.md.scripts/setup/README.mdis documentation outsidedoc/. Moving it requires updating links indoc/ci.mdanddoc/setup.md, which open PRs test-microvm: pause and resume a microVM through OpenVMM state control #405 and Adopt bind-once microVM image slots #406 also change, and a path inscripts/test_nvx_tools.py. I deferred the move.doc/design/snapshot-sharing-and-host-storage.mdomits the paired-scratch restore policy--snapshot-scratch-restore-mode(private-copy,copy-on-write,direct-claimed;openvmm/openvmm/openvmm_entry/src/cli_args/microvm.rs).doc/design/validation.mdomits some implemented scenarios, such ascpu-profile-fallbackand the structured-outcome and snapshot-tier coverage inscripts/nvx_tools/microvm_tests.py.doc/distribution.mddoesn't name the prerelease tag format orpackage --force. Both are documented elsewhere (doc/usage.md,doc/build.md). I didn't repeat them here.Validation
python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests: 117 tests, OK (1 skipped).doc/distribution.mdand in the files that link to it (README.md,doc/usage.md,doc/guests/ubuntu-guest.md,doc/guests/azurelinux-guest.md) resolves. Each changed file has one H1 and balanced code fences, anddoc/design.mdlinks every chapter indoc/design/: OK.git diff --check: clean.python scripts/nvx.py verify: passes.doc/distribution.md, so CI classifies this PR as documentation-only.