Add Validation + Checks to markdown PRs
Nobody has claimed this yet.
- Dominant language
- Svelte
- Stars
- 1.2k
- Forks
- 515
- Avg merge
- 23h
- Merged PRs (30d)
- 13
Description
We need to create a github action that does validation on the markdown files when we PR them. This way we can merge with confidence.
I've done this in the past with my uses.tech site: https://github.com/wesbos/awesome-uses/blob/master/.github/workflows/data-validate.yml
So, things that should be checked:
- Publish date is in the future
- mp3 url is valid (Fetch with HEAD to ensure file exists)
- Show number is not overlapping with any existing shows
- All links in markdown resolve 200 OK
- Perhaps some sort of spellcheck?
- Youtube url is a real youtube url (we had them mixed up once)
- all timestamp links adhere to HH:MM:SS or HH:MM
Just trying to think of others
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the referenced .github/workflows/data-validate.yml example and inspect how this repository stores markdown files and opens pull requests. Define validation for the seven listed areas, including dates, URLs, show-number collisions, YouTube URLs, and timestamp formats; done means the GitHub Action reports failures on invalid markdown changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown
- Domain
- ci-cd, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100