Awesome
action-rails_best_practices
This action runs rails_best_practices with reviewdog on pull requests to improve code review experience.
Input
inputs:
github_token:
description: GITHUB_TOKEN
default: ${{ github.token }}
workdir:
description: Working directory relative to the root directory.
default: .
### Flags for reviewdog ###
tool_name:
description: Tool name to use for reviewdog reporter
default: rails_best_practices
level:
description: Report level for reviewdog [info,warning,error]
default: error
reporter:
description: Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].
default: github-check
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
default: added
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
default: 'false'
reviewdog_flags:
description: Additional reviewdog flags
default: ''
### Flags for rails_best_practices ###
rails_best_practices_version:
description: rails_best_practices version
rails_best_practices_flags:
description: |
rails_best_practices flags (rails_best_practices --without-color --silent . <rails_best_practices_flags>)
default: ''
Usage
name: reviewdog
on: [pull_request]
jobs:
rails_best_practices:
name: runner / rails_best_practices
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: blooper05/action-rails_best_practices@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-check,github-pr-review,github-pr-check].
reporter: github-pr-review
# Change reporter level if you need.
# GitHub Status Check won't become failure with warning.
level: warning
Development
Release
haya14busa/action-bumpr
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch). Pushing tag manually by yourself also work.
haya14busa/action-update-semver
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3. ref: https://help.github.com/en/articles/about-actions#versioning-your-action
Lint - reviewdog integration
This reviewdog action itself is integrated with reviewdog to run lints which is useful for action composition based actions.
Supported linters:
- reviewdog/action-shellcheck
- reviewdog/action-shfmt
- reviewdog/action-actionlint
- reviewdog/action-yamllint
- reviewdog/action-markdownlint
- reviewdog/action-misspell
- reviewdog/action-alex
Dependencies Update Automation
This repository uses reviewdog/action-depup to update reviewdog version.