{"id":16306137,"url":"https://github.com/songmu/action-shodo-lint","last_synced_at":"2025-09-04T20:49:36.373Z","repository":{"id":59122355,"uuid":"534597004","full_name":"Songmu/action-shodo-lint","owner":"Songmu","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-14T13:00:14.000Z","size":30,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-29T17:18:42.146Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Songmu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-09T10:27:09.000Z","updated_at":"2023-12-24T02:30:36.000Z","dependencies_parsed_at":"2023-01-18T07:30:57.863Z","dependency_job_id":null,"html_url":"https://github.com/Songmu/action-shodo-lint","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"04cb9a7a2ee4e45faca7111a3766087337924aa3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"reviewdog/action-template","purl":"pkg:github/Songmu/action-shodo-lint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Songmu%2Faction-shodo-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Songmu%2Faction-shodo-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Songmu%2Faction-shodo-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Songmu%2Faction-shodo-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Songmu","download_url":"https://codeload.github.com/Songmu/action-shodo-lint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Songmu%2Faction-shodo-lint/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268256991,"owners_count":24221053,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T21:09:41.010Z","updated_at":"2025-08-01T16:08:17.495Z","avatar_url":"https://github.com/Songmu.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# action-shodo-lint\n\n[![Test](https://github.com/Songmu/action-shodo-lint/workflows/Test/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3ATest)\n[![reviewdog](https://github.com/Songmu/action-shodo-lint/workflows/reviewdog/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Areviewdog)\n[![depup](https://github.com/Songmu/action-shodo-lint/workflows/depup/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Adepup)\n[![release](https://github.com/Songmu/action-shodo-lint/workflows/release/badge.svg)](https://github.com/Songmu/action-shodo-lint/actions?query=workflow%3Arelease)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Songmu/action-shodo-lint?logo=github\u0026sort=semver)](https://github.com/Songmu/action-shodo-lint/releases)\n[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github\u0026link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)\n\nThis 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.\n\n\u003cimg width=\"811\" alt=\"スクリーンショット 2022-09-09 23 49 04\" src=\"https://user-images.githubusercontent.com/177122/189533601-b01f9a2a-a488-40ed-b7a0-aafebfed555b.png\"\u003e\n\n## Input\n\n```yaml\ninputs:\n  github_token:\n    description: 'GITHUB_TOKEN'\n    default: '${{ github.token }}'\n  ### Flags for reviewdog ###\n  level:\n    description: 'Report level for reviewdog [info,warning,error]'\n    default: 'warning'\n  filter_mode:\n    description: |\n      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].\n      Default is added.\n    default: 'added'\n  fail_on_error:\n    description: |\n      Exit code for reviewdog when errors are found [true,false]\n      Default is `false`.\n    default: 'false'\n  reviewdog_flags:\n    description: 'Additional reviewdog flags'\n    default: ''\n  ### Flags for shodo ###\n  api_token:\n    description: 'Shodo API token'\n    required: true\n  api_root:\n    description: 'Shodo API root'\n    required: true\n  base_branch:\n    description: 'Base branch'\n    default: ''\n  limit:\n    description: 'Maximum files'\n    default: '10'\n  dir:\n    description: 'Directory to be linted relative to the root directory.'\n    default: '.'\n```\n\n## Usage\n\n```yaml\nname: action-shodo-lint\non: [pull_request]\njobs:\n  shodo:\n    name: runner / shodo\n    runs-on: ubuntu-latest\n    steps:\n    - uses: Songmu/action-shodo-lint@main\n      with:\n        github_token: ${{ secrets.github_token }}\n        api_token: ${{ secrets.SHODO_API_TOKEN }}\n        api_root: 'https://api.shodo.ink/@{your_organization}/{your_project}/'\n```\n\n## Development\n\n### Release\n\n#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)\nYou can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).\nPushing tag manually by yourself also work.\n\n#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)\n\nThis action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.\nref: https://help.github.com/en/articles/about-actions#versioning-your-action\n\n### Dependencies Update Automation\nThis repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update\nreviewdog version.\n\n[![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)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsongmu%2Faction-shodo-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsongmu%2Faction-shodo-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsongmu%2Faction-shodo-lint/lists"}