add a CI job to do basic format validation on the files inside of these folders

[alice-i-cecile]

[ogbird]

Greetings! Taking a gander at this and trying to define it a bit more. Is this to adapt the existing FormatCommand to allow other inputs to cargo fmt besides --all?

[alice-i-cecile]

This is to enforce that the migration guide / release note files are the correct shape to be parsed :) No Rust code involved! @NthTensor can probably tell you more about what the exact expected shape is.

[ogbird]

Ah I see the parent task stuff, I see what's happening now!

I'll wait for NthTensor to weigh in. Thanks @alice-i-cecile !

[NthTensor]

The files in the release-notes and migration-guides folders are already formatted with the markdown uberformatter. This ticket is about validation on the file names:

• They should be snake case.
• They should not include the pr number (eg they shouldn't start with a 5+ digit number).
• The folders shouldn't be allowed to include anything except .gitkeep and .md files (to prevent people from adding images or videos to the repo).

Ideally CI should check this and prevent merge if a PR is noncompliant. There's also a thought to actually require PRs tagged with M-Needs-Release-Note of M-Needs-Migration-Guide to touch at-least one file within the respective folder (and I already have code in CI to detect this) but that's probably a separate issue.

[ogbird]

Alright, getting a clearer picture now based on both of your comments. I'm not fiddling around in the tools Rust module, I'll be in this .github/workflows area, right? Gotta get my head around it but based on these file names I'll be updating docs.yml, or maybe validation-jobs.yml? And this is just to validate file names in release_notes/ and migration-guides/?

[alice-i-cecile]

I'll be in this .github/workflows area, right?

Yep, that's my expectation.

Gotta get my head around it but based on these file names I'll be updating docs.yml, or maybe validation-jobs.yml

I'm not entirely sure here! It may make sense to do a new workflow that only runs when a particular tag or file changes are present. I'm not a CI wizard. @BD103 or @mockersf are good people to ask for help / strong opinions there.

And this is just to validate file names in release_notes/ and migration-guides/

Correct :) That seems like a great place to start. There's a number of other related validation checks we'd like to do (ensure that labelled PRs actually modify a file in the right place for example), but validating the file names is a good discrete unit of work.