- Notifications
You must be signed in to change notification settings - Fork6
🐶 Template to create your composite action based reviewdog actions
License
reviewdog/action-composite-template
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This is a template repository forreviewdog action with releaseautomation based onaction composition.ClickUse this template button to create your reviewdog action 🐶!
If you want to create your own reviewdog action from scratch without using thistemplate, please check and copy release automation flow.It's important to manage release workflow and sync reviewdog version for allreviewdog actions.
This repo contains a sample action to runmisspell.
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:'<linter-name>'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,sarif].'default:'github-check'filter_mode:description:| Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is `added` except that sarif reporter uses `nofilter`.default:'added'fail_level:description:| If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`.default:'none'reviewdog_flags:description:'Additional reviewdog flags.'default:''### Flags for <linter-name> ###locale:description:'-locale flag of misspell. (US/UK)'default:''
name:reviewdogon:[pull_request]jobs:# TODO: replace `linter_name` and `<linter-name>` with yourslinter_name:name:runner / <linter-name>runs-on:ubuntu-lateststeps: -uses:actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683# v4.2.2 -uses:reviewdog/action-composite-template@v1with: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
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).Pushing tag manually by yourself also work.
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
This reviewdog action itself is integrated with reviewdog to run lintswhich is useful foraction composition based actions.
Supported linters:
- reviewdog/action-shellcheck
- reviewdog/action-shfmt
- reviewdog/action-actionlint
- reviewdog/action-misspell
- reviewdog/action-alex
This repository usesreviewdog/action-depup to updatereviewdog version.
About
🐶 Template to create your composite action based reviewdog actions
