feat: add GH action markdown linting for spec file

[jeremyfiel]

Adds a Github action to validate the markdown for the spec files

[frankkilcommins]

@jeremyfiel I'm assuming we expect that the validate-markdown will pass here?

[jeremyfiel]

ok, this should be ready! that was more difficult than it needed to be. lol

EDIT: I also wonder if the workflow should use the format-markdown.sh script rather than running npx directly. If no file is found to lint, the npx will fail execution.

[frankkilcommins]

@jeremyfiel 1.0.1 changes have been merged into v1.0-dev. Can you merge in latest / rebase and we'll get this PR included?

[jeremyfiel]

not sure why this glob isn't working correctly. it should ignore v1.0.0 and not throw the linting errors.

any help from someone else is appreciated

- name: Lint markdown
      run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/1.0.[^0].md versions/1.[1-9].*.md versions/2.*.md

---

it seems to work just fine from the package.json script.

If i change the file name to 1.1.0 so it's a valid file to lint, i get the expected output

versions/1.1.0.md 580ms
versions/1.1.0.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h4]
...

If i change it back to 1.0.0, the file is not recognized, as expected

> bash ./scripts/format-markdown.sh versions/1.0.[^0].md versions/1.[1-9].*.md versions/2.*.md

No matching file found: versions/1.0.[^0].md
No matching file found: versions/1.[1-9].*.md
No matching file found: versions/2.*.md

---

appears changing the run command to run: npm run format-markdown from the package.json file fixes it hides it.

no idea how to fix this.. it works great on my codespace, but github actions seems to have different behavior with the glob pattern and it still picks up the v1.0.0 pattern.

I also split the jobs into separate runs. It was misleading to name the job mdv while it's running mdv and markdown-cli in the same job