docs(dvc-com-plugin): add missing README.md to unblock crates.io publish#1213
Merged
Benoît Cortier (CBenoit) merged 1 commit intoDevolutions:masterfrom Apr 10, 2026
Conversation
The ironrdp-dvc-com-plugin Cargo.toml declares readme = "README.md" but the file did not exist, causing cargo publish to fail during the release-crates workflow.
Copilot started reviewing on behalf of
Gabriel Bauman (gabrielbauman)
April 9, 2026 16:47
View session
There was a problem hiding this comment.
Pull request overview
Adds the missing README.md file required by ironrdp-dvc-com-plugin’s Cargo.toml (readme = "README.md"), unblocking cargo publish in the release workflow for the workspace.
Changes:
- Add
crates/ironrdp-dvc-com-plugin/README.mddescribing crate purpose and architecture - Include references to relevant Microsoft documentation for DVC client components
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Benoît Cortier (CBenoit)
changed the title
Benoît Cortier (CBenoit)
merged commit 6baf726
into
Devolutions:master
13 of 14 checks passed
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
README.mdtoironrdp-dvc-com-plugin, which declaresreadme = "README.md"in itsCargo.tomlbut was missing the file.Problem
The
Release cratesworkflow fails whenrelease-plzattempts tocargo publishtheironrdp-dvc-com-plugincrate:This blocks publishing of any crate that follows
ironrdp-dvc-com-pluginin the dependency graph.Fix
Added a README consistent with other crates in the workspace, describing the crate's purpose, architecture, and linking to relevant Microsoft documentation.
Note on the release-plz PR CI failure
The CI failure on PR #1212 (
release-plz/2026-04-09T06-06-06Z) is a separate issue: the lock file check fails because the release-plz branch's lock files have drifted from master after subsequent commits (e.g. #1203). This will (hopefully) self-resolve when release-plz regenerates its PR on the next cycle after this fix merges.