GitHub Actions

Good news: we ship pre-built GitHub Action with this project.

You can use it from the GitHub Marketplace:

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide

You can also specify any version instead of the latest tag.

Inputs

reporter

We support three reporting options:

• terminal (default one) when we just dump the output into Action’s logs. Is the easiest one to setup, that’s why we use it by default

• github-pr-review (recommended) when we use inline comments inside code reviews

• github-pr-check when we use GitHub PR Checks for the output

• github-check another way to use GitHub Checks for the output

Take a note that github-check, github-pr-review and github-pr-check requires GITHUB_TOKEN environment variable to be set.

Default reporter looks like so:

For example, that’s how github-pr-reviews can be set up:

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide
  with:
    reporter: 'github-pr-review'
  env:
    GITHUB_TOKEN: ${{ secrets.github_token }}

That’s how the result will look like:

path

We also support custom path to be specified:

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide
  with:
    path: './your/custom/path'

cwd

We also support custom cwd to be specified, it will be used to cd into before any other actions. It can be a custom subfolder with your configuration, etc.

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide
  with:
    cwd: './your/custom/path'

fail_workflow

Option which can be set to false with fail_workflow: false not to fail the workflow even if violations were found.

filter_mode

Can be used to find only new violations and ignore old ones. See https://github.com/reviewdog/reviewdog?tab=readme-ov-file#filter-mode

Outputs

We also support outputs from the spec, so you can later pass the output of wemake-python-styleguide to somewhere else.

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide
- name: Custom Action
  runs: echo "{{ steps.wemake-python-styleguide.outputs.output }}"