Adding documentation fixes #150
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: Static Analysis | |
| on: [push] | |
| jobs: | |
| Shell_Check: | |
| name: Shell Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Install Dependencies | |
| run: sudo apt-get install -y shellcheck | |
| - name: Shell Check | |
| run: | | |
| echo "Checking shell scripts" | |
| find . -type f -name "*.sh" -print0 | xargs -0 shellcheck | |
| Markdown_Lint_Check: | |
| name: Markdown Lint Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install markdownlint-cli | |
| run: npm install -g markdownlint-cli | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Run markdownlint | |
| run: | | |
| echo "Checking Markdown files" | |
| find . -type f -name "*.md" -print0 | xargs -0 markdownlint | |
| YAML_Lint_Check: | |
| name: YAML Lint Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install yamllint | |
| run: sudo apt install yamllint | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Run yamllint | |
| run: | | |
| echo "Checking YAML files" | |
| find . -type f -name "*.yml" -print0 | xargs -0 yamllint | |
| find . -type f -name "*.yaml" -print0 | xargs -0 yamllint |