Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/songmu/action-shodo-lint

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/songmu/action-shodo-lint
Owner: Songmu
License: mit
Created: 2022-09-09T10:27:09.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2022-09-14T13:00:14.000Z (about 2 years ago)
Last Synced: 2024-10-11T21:09:54.468Z (27 days ago)
Language: Shell
Size: 29.3 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # action-shodo-lint

[![Test](https://github.com/Songmu/action-shodo-lint/workflows/Test/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3ATest)

[![reviewdog](https://github.com/Songmu/action-shodo-lint/workflows/reviewdog/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Areviewdog)

[![depup](https://github.com/Songmu/action-shodo-lint/workflows/depup/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Adepup)

[![release](https://github.com/Songmu/action-shodo-lint/workflows/release/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Arelease)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Songmu/action-shodo-lint?logo=github&sort=semver)](https://github.com/Songmu/action-shodo-lint/releases)

[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)

This action uses the [Shodo](https://shodo.ink) proofreading API with [reviewdog](https://github.com/reviewdog/reviewdog) to provide suggestions for Japanese documents in the form of a review on a pull request.



## Input

```yaml

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: '.'

```

## Usage

```yaml

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}/'

```

## Development

### Release

#### [haya14busa/action-bumpr](https://github.com/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](https://github.com/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

### Dependencies Update Automation

This repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update

reviewdog version.

[![reviewdog depup demo](https://user-images.githubusercontent.com/3797062/73154254-170e7500-411a-11ea-8211-912e9de7c936.png)](https://github.com/Songmu/action-shodo-lint/pull/6)