{"id":14986044,"url":"https://github.com/reviewdog/action-remark-lint","last_synced_at":"2025-09-11T14:08:35.544Z","repository":{"id":40393891,"uuid":"236119348","full_name":"reviewdog/action-remark-lint","owner":"reviewdog","description":"Run remark-lint with Reviewdog :dog:","archived":false,"fork":false,"pushed_at":"2025-04-01T13:37:21.000Z","size":244,"stargazers_count":5,"open_issues_count":6,"forks_count":9,"subscribers_count":28,"default_branch":"main","last_synced_at":"2025-04-06T03:16:42.577Z","etag":null,"topics":["annotations","docker","gh-action","github-actions","github-actions-docker","linter","markdown","remark-lint","reviewdog"],"latest_commit_sha":null,"homepage":"https://github.com/reviewdog/reviewdog","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/reviewdog.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["reviewdog"],"open_collective":"reviewdog","patreon":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-01-25T03:09:19.000Z","updated_at":"2025-03-18T18:25:44.000Z","dependencies_parsed_at":"2023-01-05T13:22:05.325Z","dependency_job_id":"b5c92cbb-d7a8-4d60-a8ef-741d37eb030a","html_url":"https://github.com/reviewdog/action-remark-lint","commit_stats":{"total_commits":119,"total_committers":11,"mean_commits":"10.818181818181818","dds":0.4789915966386554,"last_synced_commit":"3a95fd9bbb9968fbdcb49e13c20ae6ee19d07acb"},"previous_names":[],"tags_count":94,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewdog%2Faction-remark-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewdog%2Faction-remark-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewdog%2Faction-remark-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reviewdog%2Faction-remark-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reviewdog","download_url":"https://codeload.github.com/reviewdog/action-remark-lint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248476375,"owners_count":21110264,"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","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":["annotations","docker","gh-action","github-actions","github-actions-docker","linter","markdown","remark-lint","reviewdog"],"created_at":"2024-09-24T14:12:11.460Z","updated_at":"2025-09-11T14:08:35.531Z","avatar_url":"https://github.com/reviewdog.png","language":"Shell","funding_links":["https://github.com/sponsors/reviewdog","https://opencollective.com/reviewdog"],"categories":["Shell"],"sub_categories":[],"readme":"# Reviewdog/action-remark-lint GitHub Action\n\n[![Test](https://github.com/reviewdog/action-remark-lint/workflows/Test/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3ATest)\n[![reviewdog](https://github.com/reviewdog/action-remark-lint/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Areviewdog)\n[![depup](https://github.com/reviewdog/action-remark-lint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Adepup)\n[![release](https://github.com/reviewdog/action-remark-lint/workflows/release/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Arelease)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-remark-lint?logo=github\u0026sort=semver)](https://github.com/reviewdog/action-remark-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\n![action screenshot](https://user-images.githubusercontent.com/17570430/102060312-4ee5e000-3df2-11eb-8c82-767afeccd8db.png)\n![action screenshot](https://user-images.githubusercontent.com/17570430/102059912-d3842e80-3df1-11eb-9b0a-2e04eab5e294.png)\n\nThis action runs [remark-lint](https://github.com/remarkjs/remark-lint) with [reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve code review experience.\n\n## Quick start\n\nIn its simplest form, this (composite) action can be used to annotate the changes that are suggested by the [remark-lint](https://github.com/remarkjs/remark-lint) linter.\n\n```yml\nname: reviewdog\non: [pull_request]\njobs:\n  remark-lint:\n    name: runner / remark-lint\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n      - name: install remark presets\n        run: npm install remark-preset-lint-recommended\n        shell: bash\n      - name: remark-lint\n        uses: reviewdog/action-remark-lint@0ffbd16536f125c00b3d7c9c32d4a5be51b51744 # v5.17.0\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          reporter: github-pr-check\n```\n\nRemark presets are also installed when they are specified them in the `dependencies` field of the `package.json` while the `install_deps` flag is enabled. This github action also works with remark-lint configuration files (see [the remark-lint documentation](https://github.com/remarkjs/remark/tree/HEAD/packages/remark-cli)).\n\n## Inputs\n\n### `github_token`\n\n**Optional**. The [GITHUB_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow). Must be in form of `github_token: ${{ secrets.github_token }}`. Defaults to `${{ github.token }}`.\n\n### `workdir`\n\n**Optional**. The directory to run remark-lint in. Defaults to `.`.\n\n### `remark_args`\n\n**Optional**. Additional remark-lint input arguments. Defaults to `\"--use=remark-preset-lint-recommended\"`. Default is applied programmatically when no input or config file is found.\n\n### `install_deps`\n\n**Optional**. Install npm dependencies (i.e. dependencies specified in the `package.json`). Defaults to `true`.\n\n### `annotate`\n\n**Optional**. Annotate remark-lint changes using reviewdog. Defaults to `true`.\n\n### `tool_name`\n\n**Optional**. Tool name to use for reviewdog reporter. Defaults to `remark-lint`.\n\n### `level`\n\n**Optional**. Report level for reviewdog `[info, warning, error]`. It's same as `-level` flag of reviewdog. Defaults to `error`.\n\n### `reporter`\n\n**Optional**. Reporter of reviewdog command `[github-pr-check, github-pr-review, github-check]`. Default is `github-pr-check`.\n\n### `filter_mode`\n\n**Optional**. Filtering mode for the reviewdog command `[added, diff_context, file, nofilter]`. Defaults to `added`.\n\n### `fail_level`\n\n**Optional**. If set to `none`, always use exit code 0 for reviewdog.\nOtherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level.\nPossible values: [`none`, `any`, `info`, `warning`, `error`]\nDefault is `none`.\n\n### `fail_on_error`\n\nDeprecated, use `fail_level` instead.\n**Optional**. Exit code for when reviewdog when errors are found `[true, false]`. Defaults to `false`.\n\n### `reviewdog_flags`\n\n**Optional**. Additional reviewdog flags. Defaults to `\"\"`.\n\n## Format your code\n\nThis action is meant to annotate any possible changes that would need to be made to make your code adhere to the [remark-lint linting guidelines](https://github.com/remarkjs/remark-lint). It does not apply these changes to your codebase. If you also want to apply the changes to your repository, you can use the [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester). You can find examples of how this is done can be found in [rickstaa/action-remark-lint](https://github.com/rickstaa/action-remark-lint/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freviewdog%2Faction-remark-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freviewdog%2Faction-remark-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freviewdog%2Faction-remark-lint/lists"}