Awesome
reviewdog-action-biome
This action runs Biome with reviewdog on pull requests to improve code review experience.
Input
inputs:
github_token:
description: 'GITHUB_TOKEN'
required: true
default: '${{ github.token }}'
workdir:
description: |
Working directory relative to the root directory.
This is where the action will look for a package.json file which declares Biome as a dependency.
Please note that this is different from the directory where the action will run Biome, which is specified in the biome_flags input.
required: false
default: '.'
### Flags for reviewdog ###
tool_name:
description: 'Tool name to use for reviewdog reporter.'
required: false
default: 'Biome'
level:
description: 'Report level for reviewdog [info,warning,error].'
required: false
default: 'error'
reporter:
description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].'
required: false
default: 'github-pr-review'
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
required: false
default: 'added'
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false].
Default is `false`.
required: false
default: 'false'
reviewdog_flags:
description: 'Additional reviewdog flags.'
required: false
default: ''
### Flags for Biome ###
biome_flags:
description: 'Flags and args for Biome command.'
required: false
default: '.'
Usage
[!NOTE]
For users who used v1.5 or lower.
This action uses biomejs/setup-biome from v1.6.0.
This will set up the appropriate version of @biomejs/biome from the lockfiles.
No need to set up manually anymore!
This is an example of commenting on a pull request and failing CI when there are issues pointed out in Biome check.
name: reviewdog
on: [pull_request]
jobs:
biome:
name: runner / Biome
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4
- uses: mongolyy/reviewdog-action-biome@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
fail_on_error: true
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.
Test
Install shellspec and run shellspec
command.
$ shellspec