Skip to content

update README.md

update README.md #702

Workflow file for this run

name: "mdformat"
on:
push:
pull_request:
# The branches below must be a subset of the branches above
schedule:
- cron: "33 1 * * 3"
jobs:
mdformat:
name: "Markdown format checking"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: cd and ls
run: |
cd ${{ github.workspace }}
ls -l
- name: Download dependencies
run: |
python -m pip install mdformat==0.7.18
- name: Format .md files
run: |
find . -name '*.md' | grep -v '/__' | xargs mdformat
- name: Check for changes
run: |
CHANGES=$(git diff --name-only HEAD --)
if [ -n "$CHANGES" ] ; then
echo "There are changes after running mdformat:"
echo "$CHANGES"
git diff
exit 1
fi