minor: add symlink for top-level README in driver directory #1535
Conversation
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
abr-egn
approved these changes
Nov 20, 2025
isabelatkinson
added a commit
to isabelatkinson/mongo-rust-driver
that referenced
this pull request
Nov 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The driver portion of the 3.4.0 release failed because of a pesky problem with
include_strthat arose when we switched to using workspaces. Very brief summary:cargo publishis run from a different directory with a copied-in README file, so README's location relative to src is different for normal compilation vs. releases. This is further discussed in this issue and this forum post, and the solution is to add a symlinked README file to thedriverdirectory.Unfortunately the macros crate was already successfully published, so I think I'll need to amend the release machinery to include an option to skip publishing mongodb-internal-macros. I'll put up a separate PR for that and then cherry-pick both to 3.4.x, add a new tag, and re-trigger the release process.