This action uses the Shodo proofreading API with reviewdog to provide suggestions for Japanese documents in the form of a review on a pull request.
inputs:
github_token:
description: 'GITHUB_TOKEN'
default: '${{ github.token }}'
### Flags for reviewdog ###
level:
description: 'Report level for reviewdog [info,warning,error]'
default: 'warning'
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 shodo ###
api_token:
description: 'Shodo API token'
required: true
api_root:
description: 'Shodo API root'
required: true
base_branch:
description: 'Base branch'
default: ''
limit:
description: 'Maximum files'
default: '10'
dir:
description: 'Directory to be linted relative to the root directory.'
default: '.'
name: action-shodo-lint
on: [pull_request]
jobs:
shodo:
name: runner / shodo
runs-on: ubuntu-latest
steps:
- uses: Songmu/action-shodo-lint@main
with:
github_token: ${{ secrets.github_token }}
api_token: ${{ secrets.SHODO_API_TOKEN }}
api_root: 'https://api.shodo.ink/@{your_organization}/{your_project}/'
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 repository uses reviewdog/action-depup to update reviewdog version.