reviewdog / action-composite-template

🐶 Template to create your reviewdog actions

action-composite-template

This is a template repository for reviewdog action with release automation based on action composition. Click Use this template button to create your reviewdog action 🐶!

If you want to create your own reviewdog action from scratch without using this template, please check and copy release automation flow. It's important to manage release workflow and sync reviewdog version for all reviewdog actions.

This repo contains a sample action to run misspell.

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: '<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].'
    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 <linter-name> ###
  locale:
    description: '-locale flag of misspell. (US/UK)'
    default: ''

Usage

name: reviewdog
on: [pull_request]
jobs:
  # TODO: replace `linter_name` and `<linter-name>` with yours
  linter_name:
    name: runner / <linter-name>
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: reviewdog/action-composite-template@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-misspell
• reviewdog/action-alex

Dependencies Update Automation

This repository uses reviewdog/action-depup to update reviewdog version.

action-composite-template's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/depup.yml

• actions/checkout v4
• reviewdog/action-depup v1

.github/workflows/labels.yml

• actions/checkout v4
• lannonbr/issue-label-manager-action 4.0.0

.github/workflows/release.yml

• actions/checkout v4
• haya14busa/action-bumpr v1
• haya14busa/action-update-semver v1
• haya14busa/action-cond v1
• actions/checkout v4
• haya14busa/action-bumpr v1

.github/workflows/reviewdog.yml

• actions/checkout v4
• haya14busa/action-cond v1
• reviewdog/action-shellcheck v1
• actions/checkout v4
• reviewdog/action-shfmt v1
• actions/checkout v4
• reviewdog/action-actionlint v1
• actions/checkout v4
• reviewdog/action-misspell v1
• actions/checkout v4
• reviewdog/action-alex v1

.github/workflows/test.yml

• actions/checkout v4
• actions/checkout v4
• actions/checkout v4

action.yml

• reviewdog/action-setup v1

---

• Check this box to trigger a request for Renovate to run again on this repository

[Question] Can we donate our actions to the reviewdog organization?

Hi @haya14busa, I have a question about the organization.
I built a github action to scan IaC files with terrascan using reviewdog. I would love to donate it to the organization.

https://github.com/yu-iskw/action-terrascan

What is terrascan?

https://github.com/accurics/terrascan

Terrascan is a static code analyzer for Infrastructure as Code. Terrascan allows you to:

Seamlessly scan infrastructure as code for misconfigurations.
Monitor provisioned cloud infrastructure for configuration changes that introduce posture drift, and enables reverting to a secure posture.
Detect security vulnerabilities and compliance violations.
Mitigate risks before provisioning cloud native infrastructure.
Offers flexibility to run locally or integrate with your CI\CD.