Proof reading #17423
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: General Linting | |
| env: | |
| OPENBB_ENABLE_QUICK_EXIT: true | |
| OPENBB_LOG_COLLECT: false | |
| OPENBB_USE_PROMPT_TOOLKIT: false | |
| OPENBB_FILE_OVERWRITE: true | |
| PIP_DEFAULT_TIMEOUT: 100 | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, edited] | |
| push: | |
| branches: | |
| - "feature/*" | |
| - "hotfix/*" | |
| - "release/*" | |
| merge_group: | |
| types: [checks_requested] | |
| # Cancel previous runs that are not yet completed. | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.repository }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| code-linting: | |
| name: General Code Linting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # actions/checkout v3.0.2 | |
| - name: Setup Python 3.9 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| architecture: x64 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-linting-${{ hashFiles('**/poetry.lock') }} | |
| restore-keys: ${{ runner.os }}-linting-${{ hashFiles('**/poetry.lock') }} | |
| - run: | | |
| pip install bandit black codespell==2.2.5 mypy==1.5.1 pylint==2.17.0 ruff==0.0.285 | |
| pip install types-pytz types-requests types-termcolor types-tabulate types-PyYAML types-python-dateutil types-setuptools types-six | |
| - run: bandit -x ./tests -r . || true | |
| - run: black --diff --check . | |
| - run: codespell --ignore-words=.codespell.ignore --skip="$(tr '\n' ',' < .codespell.skip | sed 's/,$//')" --quiet-level=2 | |
| - run: ruff . | |
| - run: mypy --ignore-missing-imports openbb_terminal | |
| - run: pylint terminal.py openbb_terminal tests | |
| markdown-link-check: | |
| name: Markdown Linting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| name: Check out the code | |
| - name: Lint Code Base | |
| uses: docker://avtodev/markdown-lint:v1 | |
| with: | |
| args: "./*.md ./changelogs/*.md ./openbb_terminal/**/*.md ./discordbot/**/*.md" | |
| json-yaml-validate: | |
| name: JSON Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: json-yaml-validate | |
| id: json-yaml-validate | |
| uses: GrantBirki/[email protected] | |
| with: | |
| exclude_file: json_validate_exclude.txt |