Added contributor's guide (#1512) #1896
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: CI | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| jobs: | |
| test_and_lint: | |
| name: Test and lint | |
| runs-on: ${{ matrix.operating-system }} | |
| strategy: | |
| matrix: | |
| operating-system: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: [3.8, 3.9, "3.10", "3.11"] | |
| fail-fast: false | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Show OS and Python version | |
| run: | | |
| echo "OS: ${{ matrix.operating-system }}" | |
| echo "Python: ${{ matrix.python-version }}" | |
| - name: Update pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install wheel | |
| run: python -m pip install --upgrade wheel | |
| - name: Install PyTorch on Linux and Windows | |
| if: > | |
| matrix.operating-system == 'ubuntu-latest' || | |
| matrix.operating-system == 'windows-latest' | |
| run: > | |
| pip install torch==2.0.1 torchvision==0.15.2 | |
| --extra-index-url https://download.pytorch.org/whl/cpu | |
| - name: Install PyTorch on MacOS | |
| if: matrix.operating-system == 'macos-latest' | |
| run: pip install torch==2.0.1 torchvision==0.15.2 | |
| - name: Install dependencies | |
| run: pip install .[tests] | |
| - name: Cleanup the build directory | |
| uses: JesseTG/rm@v1.0.3 | |
| with: | |
| path: build | |
| - name: Run PyTest | |
| run: pytest | |
| check_code_formatting_types: | |
| name: Check code formatting with Black, isort, mypy, flake8 | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.11"] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Update pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install linters | |
| run: > | |
| pip install | |
| flake8==5.0.3 | |
| flake8-docstrings==1.6.0 | |
| isort==5.11.5 | |
| mypy==0.991 | |
| types-PyYAML | |
| types-setuptools | |
| types-pkg-resources | |
| black==22.6.0 | |
| - name: Run Black | |
| run: black --config=black.toml --check . | |
| - name: Run Flake8 | |
| run: flake8 | |
| - name: Run mypy | |
| run: mypy . | |
| - name: Run isort | |
| run: isort --profile black albumentations | |
| check_transforms_docs: | |
| name: Check that transforms docs are not outdated | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.8] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Update pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install dependencies | |
| run: pip install .[develop] | |
| - name: Run checks | |
| run: python tools/make_transforms_docs.py check README.md |