Skip to content

Commit

Permalink
makefile: add readme check target for CI
Browse files Browse the repository at this point in the history
This will check if READMEs need to be update to reflect code changes.
  • Loading branch information
bradjc committed Mar 8, 2024
1 parent db66470 commit c558fd6
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,8 @@ ci-runner-github:\
ci-runner-github-format:\
ci-job-format\
ci-job-clippy\
ci-job-markdown-toc
ci-job-markdown-toc\
ci-job-readme-check
$(call banner,CI-Runner: GitHub format runner DONE)

.PHONY: ci-runner-github-build
Expand Down Expand Up @@ -374,6 +375,17 @@ endef
ci-job-markdown-toc: ci-setup-markdown-toc
$(if $(CI_JOB_MARKDOWN),$(call ci_job_markdown_toc))

define ci_job_readme_check
$(call banner,CI-Job: README Validation)
tools/check_boards_readme.py
tools/check_capsule_readme.py
tools/check-for-readmes.sh
endef

.PHONY: ci-job-readme-check
ci-job-readme-check:
$(call ci_job_readme_check)



### ci-runner-github-build jobs:
Expand Down

0 comments on commit c558fd6

Please sign in to comment.