docs: update readme #35
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: "CI" | |
| on: | |
| pull_request: | |
| branches: | |
| - master | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| concurrency: | |
| group: "${{ github.workflow }}-${{ github.ref }}" | |
| cancel-in-progress: true | |
| jobs: | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install markdownlint-cli | |
| run: | | |
| npm install -g markdownlint-cli | |
| - name: Lint markdown files | |
| run: | | |
| markdownlint \ | |
| -f \ | |
| -o markdownlint_report.log \ | |
| --ignore-path .markdownlintignore \ | |
| '**/*.md' | |
| - name: Print summary | |
| if: failure() | |
| run: | | |
| echo "### Linting report:" >> $GITHUB_STEP_SUMMARY | |
| cat markdownlint_report.log >> $GITHUB_STEP_SUMMARY | |
| echo "### Suggested changes:" >> $GITHUB_STEP_SUMMARY | |
| echo '```diff' >> $GITHUB_STEP_SUMMARY | |
| echo "$(git diff)" >> $GITHUB_STEP_SUMMARY | |
| echo '```' >> $GITHUB_STEP_SUMMARY | |
| - name: Additional checks | |
| if: always() | |
| run: | | |
| exit_code=0 | |
| # check character count | |
| for file in $(find ./docs -type f -name '*.md'); do | |
| echo "Checking $file" | |
| char_count=$(wc -c <"$file") | |
| echo "Character count: $char_count" | |
| filename=$(basename "$file") | |
| echo "Filename: $filename" | |
| if [[ $char_count -gt 4096 ]]; then | |
| echo "$file exceeds the 4096 character limit" >> $GITHUB_STEP_SUMMARY | |
| exit_code=1 | |
| fi | |
| done | |
| exit $exit_code |