marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-04 08:06:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

create check-readme-in-sync workflow

Browse Source
This commit is contained in:
kuanyi-ng
2022-02-20 00:08:10 +09:00
parent 43854a2921
commit ad08016509
1 changed files with 34 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
.github/workflows/check-readme-in-sync.yml vendored Normal file
View File

@@ -0,0 +1,34 @@
# Reference: https://github.com/Yash-Singh1/eslint-plugin-userscripts/blob/main/.github/workflows/readme-in-sync.yml
name: Check if README and docs/README are in sync
on:
push:
branches:
- master
- develop
pull_request:
branches:
- master
- develop
jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Check for difference in README.md and docs/README.md
run: |
if [ -z "$(diff README.md docs/README.md --brief)" ]
then
echo "README.md and docs/README.md are in sync"
else
echo "Make sure that README.md and docs/README.md are in sync"
echo
echo "Difference:"
echo
diff README.md docs/README.md -u
exit 1
fi