Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check

GitHub Action

python-isort

v0.1.0

python-isort

check

python-isort

Run isort on a Python project

Installation

Copy and paste the following snippet into your .yml file.

              

- name: python-isort

uses: isort/[email protected]

Learn more about this action in isort/isort-action

Choose a version

isort Github Action

This action runs isort on a Python repository.

It requires that the checkout and setup-python actions be used first.

Inputs

isortVersion

Optional. Version of isort to use. Defaults to latest version of isort.

sortPaths

Optional. List of paths to sort, relative to your project root. Defaults to .

configuration

Optional. isort configuration options to pass to the isort CLI. Defaults to -check-only --diff.

requirementsFiles

Optional. Paths to python requirements files to install before running isort. If multiple requirements files are provided, they should be separated by a space. If custom package installation is required, dependencies should be installed in a separate step before using this action.

Outputs

isort-result

Output of the isort CLI.

Example usage

name: Run isort
on:
  - push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - uses: jamescurtin/isort-action@master
        with:
            requirementsFiles: "requirements.txt requirements-test.txt"