feat: add unit tests and documentation #16
This file contains hidden or 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: Github Action - Code Quality | |
| on: | |
| pull_request: | |
| branches: [main] | |
| types: [opened, reopened, synchronize] | |
| workflow_dispatch: | |
| jobs: | |
| quality: | |
| name: Quality | |
| # The quality pipeline should not take more that 2 minutes. | |
| timeout-minutes: 2 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get changed markdown files | |
| id: changed-markdown | |
| uses: tj-actions/changed-files@v41 | |
| with: | |
| files: | | |
| **/*.md | |
| .github/workflows/github-action-code-quality.yml | |
| - name: Lint all Documentation | |
| if: steps.changed-markdown.outputs.any_modified == 'true' | |
| uses: DavidAnson/markdownlint-cli2-action@v14 | |
| with: | |
| globs: | | |
| **/*.md |