neon icon indicating copy to clipboard operation
neon copied to clipboard

ci: adds separate doc checks for markdown files and not triggering the build_and_test ci

Open swaingotnochill opened this issue 7 months ago • 4 comments

Problem

Making any doc changes triggers the entire ci/cd for build and test.

Summary of changes

This is an attempt to start refactoring the ci for avoiding unnecessary builds for docs. The change includes: ignoring *.md and docs/*.md files in PR for build_and_test and neon_extra_builds, and adding a doc_checks.yml ci to handle the docs separately.

  • Ignores *.md and docs folder in "build_and_test.yml" and "neon_extra_builds.yml".
  • Adds a new doc-checks for the markdown files that are present in the current pull request.
  • Uses rust dprint for *.md formatting, mlc for markdown link checking
  • Finally runs cargo doc to run any additional rust documentation checks.

Checklist before requesting a review

  • [x] I have performed a self-review of my code.
  • [x] If it is a core feature, I have added thorough tests.
  • [x] Do we need to implement analytics? if so did you add the relevant metrics to the dashboard?
  • [x] If this PR requires public announcement, mark it with /release-notes label and add several sentences in this section.

Checklist before merging

  • [ ] Do not forget to reformat commit message to not include the above checklist

swaingotnochill avatar Jul 21 '24 20:07 swaingotnochill