-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
document-features fails when markdown headers (##
) is used in a TOML string (was "docs.rs builds failing")
#25
Comments
I can reproduce the problem locally from your snapbox repository if i first do the
(doesn't need nightly, this is rust 1.79) But i can also reproduce with the version 0.6.10 of that crate and with older rust version. So i can understand why this fails, but i cannot understand how it worked before. |
I made a "fix" but I realize it's not a fix because it wouldn't have an error anymore, but wouldn't also have any feature. The strange thing is that there is a difference in the Cargo.toml which is not shown by the diff: If you look at https://docs.rs/crate/snapbox/0.6.10/source/Cargo.toml , it contains: [[package.metadata.release.pre-release-replacements]]
exactly = 1
file = "CHANGELOG.md"
replace = "<!-- next-header -->\n## [Unreleased] - ReleaseDate\n"
search = "<!-- next-header -->" However, from https://docs.rs/crate/snapbox/0.6.11/source/Cargo.toml [[package.metadata.release.pre-release-replacements]]
exactly = 1
file = "CHANGELOG.md"
replace = """
<!-- next-header -->
## [Unreleased] - ReleaseDate
"""
search = "<!-- next-header -->" I don't understand why they are different. If I look at the .crate file downloaded by cargo in ~/.cargo/registry/cache/index.crates.io-6f17d22bba15001f/snapbox-0.6.10.crate , it does have the (This difference makes the test in this condition being different: Line 257 in c39c610
|
CC #25
Fixed in 0.2.9 But the reason why the file Cargo.toml was different for docs.rs than what is in the crate package is still a mystery to me. |
The new version caused regression so i yanked it for now. |
Looks like docs.rs is loading and rewriting the |
##
) is used in a TOML string (was "docs.rs builds failing")
should work now in 0.2.10 |
This happened on snapbox 0.6.12 (https://docs.rs/crate/snapbox/0.6.12/builds/1287788) and 0.6.11 but not before.
If you diff my package between 0.6.10 and 0.6.12, there are no relevant changes, see https://diff.rs/snapbox/0.6.10/0.6.12/Cargo.toml
In fact,
[Unreleased] - ReleaseDate
does not show up on a dedicated line in my mamanifest but does show up in a nested TOML string (not on its own line)
However, I'm not able to reproduce this locally
$ RUSTFLAGS="--cfg docsrs" cargo +nightly doc --no-deps -F document-features
Anyone else seeing this?
The text was updated successfully, but these errors were encountered: