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.

Sign up for GitHub

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

Jump to bottom

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

Open
iulianbarbu opened this issue Nov 1, 2024 · 2 comments · May be fixed by #6359
Open

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

iulianbarbu opened this issue Nov 1, 2024 · 2 comments · May be fixed by #6359
Assignees
@virajbhartiya
Labels
C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK.

Comments

@iulianbarbu
Copy link
Contributor

iulianbarbu commented Nov 1, 2024 •
edited
Loading

#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.
@iulianbarbu iulianbarbu added the C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK. label Nov 1, 2024
@iulianbarbu iulianbarbu mentioned this issue Nov 1, 2024
Merged
3 tasks
@virajbhartiya
Copy link

Can I work on this?

@iulianbarbu
Copy link
Contributor Author

Hey @virajbhartiya ! Thanks for the interest and sure, you can look into it. Will assign this to you in the meantime.

@virajbhartiya virajbhartiya linked a pull request Nov 5, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@virajbhartiya virajbhartiya

Labels
C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK.
Projects
Polkadot Omni Node
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add workflow to test readme generation virajbhartiya/polkadot-sdk
2 participants
@iulianbarbu @virajbhartiya