Create CI workflow that checks README.docify.md's are in sync with README.mds #6331
Assignees
Labels
C2-good-first-issue
A task for a first time contributor to become familiar with the Polkadot-SDK.
Comments
iulianbarbu
added
the
C2-good-first-issue
3 tasks
|
Can I work on this? |
|
Hey @virajbhartiya ! Thanks for the interest and sure, you can look into it. Will assign this to you in the meantime. |
github-merge-queue bot
pushed a commit
that referenced
this issue
Nov 14, 2024
# 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: 1. Copy the `.github/workflows/readme-check.yml` file to their repository 2. Ensure any `README.docify.md` files in their project follow the expected format 3. Implement the `generate-readme` feature flag in their Cargo.toml if not already present ## Review 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: - The workflow runs on both PRs and pushes to main - It finds all `README.docify.md` files recursively in the repository - For each file found: - Builds the project with `--features generate-readme` in that directory - Checks if the README.md has any uncommitted changes - Fails if any README.md is out of sync --------- Co-authored-by: Alexander Samusev <[email protected]> Co-authored-by: Iulian Barbu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
#5954 will introduce a README.md generated from a README.docify.md. We used
docify::compile_markdown!inside thelib.rsof thestaging-chain-spec-buildercrate.We must search for README.docify.md in the repo, and run
cargo build --features generate-readmein the dir of the file (assuming it is related to a crate). If thegit diffshows some output for theREADME.md, then the file update wasn't pushed on the branch, and the workflow should fail.The text was updated successfully, but these errors were encountered: