Skip to content
Check Commit

docs(k8s): improve documentation #1592

Sign in to view logs

docs(k8s): improve documentation

docs(k8s): improve documentation #1592

Workflow file for this run

.github/workflows/checks.yml at 9373ae2
name: Check Commit
on:
push:
branches:
- main
pull_request:
merge_group:
jobs:
format:
runs-on: ubuntu-latest
strategy:
matrix:
lib:
- scaleway-core
- scaleway
- scaleway-async
defaults:
run:
working-directory: ${{ matrix.lib }}
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Install poetry
run: |
pip install poetry
poetry --version
- name: Install dependencies and library
run: poetry install
- name: Check format
run: poetry run ruff format --check
typing:
runs-on: ubuntu-latest
strategy:
matrix:
lib:
- scaleway-core
- scaleway
- scaleway-async
defaults:
run:
working-directory: ${{ matrix.lib }}
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Install poetry
run: |
pip install poetry
poetry --version
- name: Install dependencies and library
run: poetry install
- name: Check typing
run: poetry run mypy --install-types --non-interactive --strict --no-warn-unused-ignores $(echo "${{ matrix.lib }}" | tr "-" "_")
linting:
runs-on: ubuntu-latest
strategy:
matrix:
lib:
- scaleway-core
- scaleway
- scaleway-async
defaults:
run:
working-directory: ${{ matrix.lib }}
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Install poetry
run: |
pip install poetry
poetry --version
- name: Install dependencies and library
run: poetry install
# We ignore the following rules for now:
# E721 (https://docs.astral.sh/ruff/rules/type-comparison)
# F541 (https://docs.astral.sh/ruff/rules/f-string-missing-placeholders)
- name: Check linting
run: poetry run ruff check . --ignore E721 --ignore F541
# tests:
# runs-on: ubuntu-latest
# strategy:
# matrix:
# lib:
# - scaleway-core
# - scaleway
# - scaleway-async
# defaults:
# run:
# working-directory: ${{ matrix.lib }}
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: 3.8
# - name: Install poetry
# run: |
# pip install poetry
# poetry --version
# - name: Install dependencies and library
# run: poetry install
# - name: Run tests
# run: poetry run python -m unittest discover -s tests -v
# env:
# SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
# SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
# SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
# SCW_DEFAULT_REGION: ${{ secrets.SCW_DEFAULT_REGION }}
# SCW_DEFAULT_ZONE: ${{ secrets.SCW_DEFAULT_ZONE }}