Skip to content

Create CI workflow that checks README.docify.md's are in sync with README.mds #6331

@iulianbarbu

Description

@iulianbarbu

#5954 will introduce a README.md generated from a README.docify.md. We used docify::compile_markdown! inside the lib.rs of the staging-chain-spec-builder crate.

We must 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 should fail.

Metadata

Metadata

Assignees

Labels

C2-good-first-issueA task for a first time contributor to become familiar with the Polkadot-SDK.

Type

No type
No fields configured for issues without a type.

Projects

Status
Milestone 1

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions