{"id":19211335,"url":"https://github.com/truebrain/actions-flake8","last_synced_at":"2025-09-10T03:38:16.189Z","repository":{"id":38387387,"uuid":"218130746","full_name":"TrueBrain/actions-flake8","owner":"TrueBrain","description":"Flake8 with GitHub Actions -- including annotations for Pull Requests","archived":false,"fork":false,"pushed_at":"2024-10-14T17:31:22.000Z","size":38,"stargazers_count":25,"open_issues_count":3,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-22T03:24:10.077Z","etag":null,"topics":["actions","annotations","flake8","github-actions","linter","python"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TrueBrain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-28T19:39:43.000Z","updated_at":"2024-10-14T17:30:04.000Z","dependencies_parsed_at":"2024-06-18T15:37:30.907Z","dependency_job_id":"d2726e9e-63e8-4b71-a5d0-dc7ae00d4eff","html_url":"https://github.com/TrueBrain/actions-flake8","commit_stats":{"total_commits":38,"total_committers":7,"mean_commits":5.428571428571429,"dds":"0.39473684210526316","last_synced_commit":"36ab8db923b9a63cfd4b87840ca2f94c117bb50e"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBrain%2Factions-flake8","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBrain%2Factions-flake8/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBrain%2Factions-flake8/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrueBrain%2Factions-flake8/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TrueBrain","download_url":"https://codeload.github.com/TrueBrain/actions-flake8/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427012,"owners_count":20937214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","annotations","flake8","github-actions","linter","python"],"created_at":"2024-11-09T13:42:11.066Z","updated_at":"2025-04-06T03:12:29.925Z","avatar_url":"https://github.com/TrueBrain.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flake8 with GitHub Actions -- including annotations for Pull Requests\n\n[![GitHub License](https://img.shields.io/github/license/TrueBrain/actions-flake8)](https://github.com/TrueBrain/actions-flake8/blob/main/LICENSE)\n[![GitHub Tag](https://img.shields.io/github/v/tag/TrueBrain/actions-flake8?include_prereleases\u0026label=stable)](https://github.com/TrueBrain/actions-flake8/releases)\n[![GitHub commits since latest release](https://img.shields.io/github/commits-since/TrueBrain/actions-flake8/latest/main)](https://github.com/TrueBrain/actions-flake8/commits/main)\n\nThis GitHub Actions runs [flake8](https://github.com/PyCQA/flake8) over your code.\nAny warnings or errors will be annotated in the Pull Request.\n\n## Usage\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n```\n\nBy default, it uses the default Python version as installed on the GitHub Runner.\n\n### Different Python version\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: actions/setup-python@v5\n  with:\n    python-version: 3.9\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    path: src\n```\n\n### Parameter: flake8_version\n\nIn some cases you might want to pin a certain flake8 version.\n\nThis parameter is optional; by default the latest flake8 will be installed (if no flake8 is installed yet).\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    flake8_version: 6.1.0\n```\n\nAlternatively, you can pre-install flake8 before executing this action:\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- run: pip install flake8==3.8.0\n- uses: TrueBrain/actions-flake8@v2\n```\n\nIf needed, this also allows you to install other flake8-plugins.\n\n### Parameter: path\n\nIndicates the path to run `flake8` in.\nThis can be useful if your project is more than Python code.\n\nThis parameter is optional; by default `flake8` will run on your whole repository.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    path: src\n```\n\n### Parameter: ignore\n\nIndicates errors and warnings to skip.\n\nThis parameter is optional; by default no alerts will be ignored\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    ignore: E4,W\n```\n\n### Parameter: max_line_length\n\nIndicates the maximum allowed line length.\n\nThis parameter is optional; by default flake8's default line length will be used.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    max_line_length: 90\n```\n\n### Parameter: only_warn\n\nOnly warn about problems.\nAll errors and warnings are annotated in Pull Requests, but it will act like everything was fine anyway.\n(In other words, the exit code is always 0.)\n\nThis parameter is optional; setting this to any value will enable it.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    only_warn: 1\n```\n\n### Parameter: plugins\n\nList of plugins to install before running, This is passed directly to `pip install`.\n\nThis parameter is optional; setting this to any value will enable it.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    plugins: flake8-bugbear cohesion==0.9.1\n```\n\n### Parameter: error_classes\n\nList of flake8 [error classes](https://flake8.pycqa.org/en/latest/glossary.html#term-error-class) to classify as Error.\n\nThis parameter is optional; by default `E` and `F` classes will be considered errors.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    error_classes: E,H\n```\n\n### Parameter: warning_classes\n\nList of flake8 [error classes](https://flake8.pycqa.org/en/latest/glossary.html#term-error-class) to classify as Warning.\n\nThis parameter is optional; by default all classes not contained in `error_classes` will be considered a warning.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    warning_classes: W,B,D\n```\n\n### Parameter: extra_arguments\n\nExtra arguments to give to flake8.\nUseful when you need to give an argument this action otherwise doesn't supply (like `--max-complexity`, `--hang-closing`, ...).\n\nThis parameter is optional; by default it is empty.\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    extra_arguments: \"--hang-closing\"\n```\n\n### Parameter: working_directory\n\nChange the current working-directory to execute flake8 in.\n\nThis parameter is optional; by default it is set to \".\".\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: TrueBrain/actions-flake8@v2\n  with:\n    working_directory: \"src\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftruebrain%2Factions-flake8","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftruebrain%2Factions-flake8","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftruebrain%2Factions-flake8/lists"}