[Feature] CLI docs #25197
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/[email protected] # actions/checkout v3.0.2 | |
| with: | |
| ref: ${{ github.event.pull_request.head.ref || github.ref }} | |
| repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }} | |
| fetch-depth: 20 | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Fetch base branch | |
| run: git fetch --no-tags --depth=20 origin ${{ github.base_ref }} | |
| - name: Setup Python 3.9 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| architecture: x64 | |
| - name: Get changed files in openbb_platform for PR | |
| if: github.event_name == 'pull_request' | |
| run: | | |
| # "Checking PR diff" | |
| echo "platform_files=$(git diff --diff-filter=d --name-only origin/${{ github.base_ref }}...${{ github.head_ref }} | grep 'openbb_platform/.*\.py$' | grep -v 'openbb_platform/openbb/package' | grep -v 'integration' | grep -v 'tests' | xargs)" >> $GITHUB_ENV | |
| echo $platform_files | |
| - 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 openbb-devtools | |
| 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: | | |
| # Run linters for openbb_platform | |
| if [ -n "${{ env.platform_files }}" ]; then | |
| pylint ${{ env.platform_files }} | |
| mypy ${{ env.platform_files }} --ignore-missing-imports --scripts-are-modules --check-untyped-defs | |
| pydocstyle ${{ env.platform_files }} | |
| else | |
| echo "No Python files changed in openbb_platform" | |
| fi | |
| 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] |