Skip to content

Commit

Permalink
Add markdown-toc to CI checks (#2023)
Browse files Browse the repository at this point in the history
* Add markdown-toc to tooling

* Remove special characters from markdown toc

* Add markdown-toc CI check

* Remove sudo from markdown-toc CI check

* Fix merge issue
  • Loading branch information
djaglowski authored Oct 16, 2021
1 parent 98590d9 commit e84d2ce
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ jobs:
- name: run markdown-link-check
run: make markdown-link-check

markdown-toc-check:
runs-on: ubuntu-latest
steps:
- name: check out code
uses: actions/checkout@v2

- name: install markdown-toc
run: make install-markdown-toc

- name: run markdown-toc
run: make markdown-toc

- name: validate markdown-toc
run: git diff --exit-code ':*.md' || (echo 'Generated markdown Table of Contents is out of date, please run "make markdown-toc" and commit the changes in this PR.' && exit 1)

misspell:
runs-on: ubuntu-latest
steps:
Expand Down

0 comments on commit e84d2ce

Please sign in to comment.