python-lint/action.yml at master · sailingpalmtree/python-lint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# GitHub Action to run flakeheaven through reviewdog.
# flakeheaven (https://github.com/flakeheaven/flakeheaven) integrates well with legacy code
# reviewdog (https://github.com/reviewdog) adds inline comments for PRs/commits
#
# This Action was created using reviewdog's Action Template
# https://github.com/reviewdog/action-template
name: 'Python linting with flakeheaven and reviewdog'
description: '🐶 Run flakeheaven with reviewdog on pull requests to improve code review experience.'
author: 'Balint Gyimesi'
inputs:
  github_token:
    description: 'GITHUB_TOKEN'
    default: '${{ github.token }}'
    required: false
  workdir:
    description: 'Working directory relative to the root directory.'
    default: '.'
    required: false
  python_version:
    description: 'The Python version to use for flakeheaven, e.g. python3.8'
    # Don't forget to update this in the Dockerfile too until this is fixed:
    # https://github.community/t/feature-request-build-args-support-in-docker-container-actions/16846/15
    default: 'python3.8'
    required: false

  ### Flags for reviewdog
  level:
    description: 'Report level for reviewdog [info,warning,error]'
    default: 'warning'
    required: false
  reporter:
    description: 'Reporter of reviewdog command [github-pr-check,github-pr-review].'
    default: 'github-pr-check'
    required: false
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: 'added'
    required: false
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: 'false'
    required: false
  reviewdog_flags:
    description: 'Additional reviewdog flags'
    default: ''
    required: false

  ### Flags for flakeheaven
  # None currently, flakeheaven is configured through pyproject.toml

runs:
  using: 'docker'
  image: 'Dockerfile'

# Ref: https://haya14busa.github.io/github-action-brandings/
branding:
  icon: 'check-circle'
  color: 'blue'