Skip to content
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

Test that cargo readme output matches README.md #18

Closed
joshlf opened this issue Oct 1, 2022 · 1 comment
Closed

Test that cargo readme output matches README.md #18

joshlf opened this issue Oct 1, 2022 · 1 comment

Comments

@joshlf
Copy link
Member

joshlf commented Oct 1, 2022

We use the following command to auto-generate the contents of README.md from the crate-level doc comment in src/lib.rs:

cargo readme | sed 's/\[\(`[^`]*`\)]/\1/g'

The sed command removes code links like:

/// Here is a link to [`Vec<u8>`].

We should add a test that the output of that command matches the current contents of README.md, which will ensure PRs which edit that doc comment but do not update README.md can't be spuriously merged.

This was referenced Oct 2, 2022
@joshlf
Copy link
Member Author

joshlf commented Oct 4, 2022

Fixed in fa7e3e8.

@joshlf joshlf closed this as completed Oct 4, 2022
@joshlf joshlf mentioned this issue Aug 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant