feat: add workflow to test readme generation #6359
Open
+63
−1
Conversation
This file contains 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
|
User @virajbhartiya, please sign the CLA here. |
virajbhartiya
changed the title
iulianbarbu
reviewed
Nov 7, 2024
|
I have made the changes according to the give code review, please do give it a look and let me know if any other changes are required |
iulianbarbu
reviewed
Nov 7, 2024
|
Could you please help me out with the 'check-prdoc' and 'check-labels' CI failure |
alvicsam
requested changes
Nov 7, 2024
Co-authored-by: Alexander Samusev <[email protected]>
…nts and update Rust toolchain setup
iulianbarbu
reviewed
Nov 7, 2024
iulianbarbu
reviewed
Nov 7, 2024
iulianbarbu
reviewed
Nov 7, 2024
iulianbarbu
reviewed
Nov 11, 2024
There was a problem hiding this comment.
Hey @virajbhartiya ! Thanks a lot of addressing the previous rounds of feedback. We're almost there in terms of merging. Would be great to address what @alvicsam mentioned here: #6359 (review) too (meaning moving the job under checks-quick.yml, right before confirm-requried-checks-quick-jobs-passed, and I would add to also add it to the needs list of the same job).
Co-authored-by: Iulian Barbu <[email protected]>
Co-authored-by: Iulian Barbu <[email protected]>
Co-authored-by: Iulian Barbu <[email protected]>
iulianbarbu
reviewed
Nov 11, 2024
iulianbarbu
approved these changes
Nov 11, 2024
|
Review required! Latest push from author must always be reviewed |
iulianbarbu
approved these changes
Nov 11, 2024
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.
Description
Created a workflow to search for README.docify.md in the repo, and run cargo build --features generate-readme in the dir of the file (assuming it is related to a crate). If the git diff shows some output for the README.md, then the file update wasn't pushed on the branch, and the workflow fails.
Closes #6331
Integration
Downstream projects that want to adopt this README checking workflow should:
.github/workflows/readme-check.ymlfile to their repositoryREADME.docify.mdfiles in their project follow the expected formatgenerate-readmefeature flag in their Cargo.toml if not already presentReview Notes
This PR adds a GitHub Actions workflow that automatically verifies README.md files are up-to-date with their corresponding README.docify.md sources. Key implementation details:
README.docify.mdfiles recursively in the repository--features generate-readmein that directory