reviewdog/action-suggesterPublic

generated fromreviewdog/action-template

NotificationsYou must be signed in to change notification settings
Fork17
Star131

🐶 Suggests any code changes based on diff through GitHub Multi-line code suggestions by using reviewdog

License

MIT license

131 stars 17 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 193 Commits
.github		.github
testdata		testdata
LICENSE		LICENSE
README.md		README.md
action.yml		action.yml
script.sh		script.sh

Repository files navigation

action-suggester

action-suggester is a handy action which suggests any code changes based ondiff through GitHub Multi-line code suggestions by usingreviewdog.

You can use any formatters or linters with auto-fix feature for any languagesand the reviewdog suggester support any changes including inline change,multi-line changes, insertion, and deletion.

Input

inputs:github_token:description:'GITHUB_TOKEN'default:'${{ github.token }}'### Flags for reviewdog ###tool_name:description:'Tool name to use for reviewdog reporter'default:'reviewdog-suggester'level:description:'Report level for reviewdog [info,warning,error]'default:'warning'filter_mode:description:|      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].      Default is diff_context. GitHub suggestions only support added and diff_context.default:'diff_context'fail_level:description:|      Exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to given level [none,any,info,warning,error].      If set to `none`, always exit with 0.      Default is `none`.default:'none'fail_on_error:description:|      Exit code for reviewdog when errors are found [true,false]      Default is `false`.deprecationMessage:Deprecated, use `fail_level` instead.default:'false'reviewdog_flags:description:'Additional reviewdog flags'default:''### Flags for reviewdog suggester ###cleanup:description:'Clean up non-committed changes after the action'default:'true'

Required Permissions

The action requires the following permissions:

permissions:contents:readchecks:writeissues:writepull-requests:write

SeeAssigning permissions to jobs for more details.

Usage Example

name:reviewdog-suggesteron:[pull_request]# Support only pull_request event.jobs:go:name:runner / suggester / gofmtruns-on:ubuntu-lateststeps:      -uses:actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683# v4.2.2      -run:gofmt -w -s .      -uses:reviewdog/action-suggester@4747dbc9f9e37adba0943e681cc20db466642158# v1.21.0with:tool_name:gofmtshell:name:runner / suggester / shellruns-on:ubuntu-lateststeps:      -uses:actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683# v4.2.2      -uses:actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe# v4.1.0      -run:go install mvdan.cc/sh/v3/cmd/shfmt@latest      -run:shfmt -i 2 -ci -w .      -name:suggester / shfmtuses:reviewdog/action-suggester@4747dbc9f9e37adba0943e681cc20db466642158# v1.21.0with:tool_name:shfmt# Need to install latest shellcheck to use diff output format as of writing (2020/08/03).      -name:install shellcheckrun:|          scversion="latest"          wget -qO- "https://github.com/koalaman/shellcheck/releases/download/${scversion?}/shellcheck-${scversion?}.linux.x86_64.tar.xz" | tar -xJv          sudo cp "shellcheck-${scversion}/shellcheck" /usr/local/bin/          rm -rf "shellcheck-${scversion}/shellcheck"      -run:shellcheck -f diff $(shfmt -f .) | patch -p1      -name:suggester / shellcheckuses:reviewdog/action-suggester@4747dbc9f9e37adba0943e681cc20db466642158# v1.21.0with:tool_name:shellcheck