Add Validation + Checks to markdown PRs

[wesbos]

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:

1. Publish date is in the future
2. mp3 url is valid (Fetch with HEAD to ensure file exists)
3. Show number is not overlapping with any existing shows
4. All links in markdown resolve 200 OK
5. Perhaps some sort of spellcheck?
6. Youtube url is a real youtube url (we had them mixed up once)
7. all timestamp links adhere to HH:MM:SS or HH:MM

Just trying to think of others

[stolinski]

Is this something you are working on or just documenting.

[wesbos]

Just documenting, feel free tot take it on ! Github actions are pain. Worth checking out https://github.com/nektos/act

[wesbos]

A few more from this morning's scramble:

1. If a file is committed to the shows folder, it should have a .md extension
2. Any URLs should resolve - we had some file://Users/.... paths from copy + pasting markdown from VS code
3. The markdown should parse and be valid - we had an extra --- added to the frontmatter
4. Youtube links should be full youtube.com links and not youtu.be - not sure if this is a big deal or not, just thought I'd mention it. I feel like linking straight to the video is better than a shortlink - probably some SEO juice there.

[stolinski]

Making these into a todo list

• 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? (prob a can of worms)
• Youtube url is a real youtube url (we had them mixed up once)
• all timestamp links adhere to HH:MM:SS or HH:MM
• If a file is committed to the shows folder, it should have a .md extension
• Any URLs should resolve - we had some file://Users/.... paths from copy + pasting markdown from VS code
• The markdown should parse and be valid - we had an extra --- added to the frontmatter
• Youtube links should be full youtube.com links and not youtu.be

[stolinski]

Going to merge the first 2 of these checks and then add on the others.
Here is the test runs #1543

[stolinski]

Just merged timestamp validation

[wesbos]

Another thing we should add is making sure the mp3 is only 128kbs bitrate, and/or the file size is not over ~70mb. We had released one that was 128mb and it was causing timeouts on the transcript generation.

We already have ffmpeg wasm package installed, so we could check that way, but honestly checking the filesize would be good enough too.

[wesbos]

@stolinski This markdown:

* **[32:15](#t=32:15)** Is ChatGPT Plus worth it? I'm trying to avoid death by 1000 subscriptions.
* [Mozilla’s vision for Firefox MV3](https://blog.mozilla.org/addons/2022/11/17/manifest-v3-signing-available-november-21-on-firefox-nightly/

is thinking those numbers in the urls are timestamps

[wesbos]

@stolinski happened again here

[stolinski]

Will examine 🤔 need to tweak the regex looking for times.

[wesbos]

I think the regex might be wrong on purpose for testing? https://github.com/syntaxfm/website/blob/main/scripts/merging-show-validation.js#L31

IMO I'd parse the show notes, and then feed it into linkedom, then you can just document.querySelector([href^="#t="]` to get all the correct links instead of regexing everything

[stolinski]

Def not wrong on purpose. Just too broad Scott Tolinski www.scotttolinski.com ( http://www.scotttolinski.com/ )

…

On Fri, Mar 1 2024 at 1:59 PM, Wes Bos < ***@***.*** > wrote: I think the regex might be wrong on purpose for testing? https://github.com/syntaxfm/website/blob/main/scripts/merging-show-validation.js#L31 IMO I'd parse the show notes, and then feed it into linkedom , then you can just document.querySelector( [href^="#t="]` to get all the correct links instead of regexing everything — Reply to this email directly, view it on GitHub ( #1538 (comment) ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AAFDNR23Z635AEVNG7P6PZ3YWDT2BAVCNFSM6AAAAABC6NYW52VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZTHEYTAMRWHA ). You are receiving this because you were mentioned. Message ID: <syntaxfm/website/issues/1538/1973910268 @ github. com>

[stolinski]

That said query selector all is probably the right call because it’s so targeted Scott Tolinski www.scotttolinski.com ( http://www.scotttolinski.com/ )

…

On Fri, Mar 1 2024 at 1:59 PM, Scott Tolinski < ***@***.*** > wrote: Def not wrong on purpose. Just too broad Scott Tolinski www.scotttolinski.com ( http://www.scotttolinski.com/ ) On Fri, Mar 1 2024 at 1:59 PM, Wes Bos < ***@***.*** > wrote: > > > > > > > I think the regex might be wrong on purpose for testing? https://github.com/syntaxfm/website/blob/main/scripts/merging-show-validation.js#L31 > > > > > IMO I'd parse the show notes, and then feed it into linkedom , then you can > just document.querySelector( [href^="#t="]` to get all the correct links > instead of regexing everything > > > > — > Reply to this email directly, view it on GitHub ( > #1538 (comment) ) , > or unsubscribe ( > https://github.com/notifications/unsubscribe-auth/AAFDNR23Z635AEVNG7P6PZ3YWDT2BAVCNFSM6AAAAABC6NYW52VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZTHEYTAMRWHA > ). > You are receiving this because you were mentioned. Message ID: <syntaxfm/website/issues/1538/1973910268 > @ github. com> > > >

[wesbos]

Yeah, plus rendering the markdown will also tell us if the markdown will render on the site. Easy way to detect any issues