reviewdog/action-templatePublic template

generated fromhaya14busa/action-docker-template

NotificationsYou must be signed in to change notification settings
Fork12
Star24

🐶 Template to create your Docker based reviewdog actions

License

MIT license

24 stars 12 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 169 Commits
.github		.github
testdata		testdata
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
action.yml		action.yml
entrypoint.sh		entrypoint.sh

Repository files navigation

action-template

This is a template repository forreviewdog action with release automation.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.

Input

inputs:github_token:description:'GITHUB_TOKEN'default:'${{ github.token }}'workdir:description:'Working directory relative to the root directory.'default:'.'### Flags for reviewdog ###level:description:'Report level for reviewdog [info,warning,error]'default:'error'reporter:description:'Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].'default:'github-pr-check'filter_mode:description:|      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].      Default is added.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:''

Usage

name:reviewdogon:[pull_request]jobs:# TODO: change `linter_name`.linter_name:name:runner / <linter-name>runs-on:ubuntu-lateststeps:      -uses:actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683# v4.2.2      -uses:reviewdog/action-template@c0a1d65401d8e3c97336c75bb4b6f85677e8f27f# v1.20.0with:github_token:${{ secrets.github_token }}# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].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