{"id":16539471,"url":"https://github.com/rickstaa/action-remark-lint","last_synced_at":"2026-04-12T17:05:22.946Z","repository":{"id":43088430,"uuid":"327581040","full_name":"rickstaa/action-remark-lint","owner":"rickstaa","description":"Runs the remark-lint linter to check/format your python code.","archived":false,"fork":false,"pushed_at":"2023-09-04T14:18:05.000Z","size":40,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T16:20:18.796Z","etag":null,"topics":["codequality","continious-integration","docker","formatter","gh-action","github-actions","github-actions-docker","linter","markdown"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/run-remark-lint","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/rickstaa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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":["rickstaa"]}},"created_at":"2021-01-07T10:41:50.000Z","updated_at":"2022-03-19T08:21:29.000Z","dependencies_parsed_at":"2024-11-14T18:48:51.790Z","dependency_job_id":null,"html_url":"https://github.com/rickstaa/action-remark-lint","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/rickstaa/action-remark-lint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Faction-remark-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Faction-remark-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Faction-remark-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Faction-remark-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rickstaa","download_url":"https://codeload.github.com/rickstaa/action-remark-lint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Faction-remark-lint/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268495926,"owners_count":24259401,"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-03T02:00:12.545Z","response_time":2577,"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":["codequality","continious-integration","docker","formatter","gh-action","github-actions","github-actions-docker","linter","markdown"],"created_at":"2024-10-11T18:49:10.620Z","updated_at":"2026-04-12T17:05:22.915Z","avatar_url":"https://github.com/rickstaa.png","language":"Shell","funding_links":["https://github.com/sponsors/rickstaa"],"categories":[],"sub_categories":[],"readme":"# Action-remark-lint GitHub Action\n\n[![Test](https://github.com/rickstaa/action-remark-lint/workflows/Test/badge.svg)](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3ATest)\n[![release](https://github.com/rickstaa/action-remark-lint/workflows/release/badge.svg)](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3Arelease)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rickstaa/action-remark-lint?logo=github\\\u0026sort=semver)](https://github.com/rickstaa/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\nThis action runs the [remark-lint linter](https://github.com/remarkjs/remark-lint) to check/format your markdown code on a push or pull request.\n\n## Quickstart\n\n```yml\nname: remark-lint-action\non: [push, pull_request]\njobs:\n  remark-lint:\n    name: runner / remark-lint\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v1\n      - name: remark-lint\n        uses: rickstaa/action-remark-lint@v1\n```\n\n## Inputs\n\n### `remark_args`\n\n**optional**: Remark-lint input arguments. Defaults to `. --frail --quiet`.\n\n### `fail_on_error`\n\n**optional**: Exit code when remark-lint linting errors are found \\[true, false]. Defaults to 'true'.\n\n## Outputs\n\n### `is_formatted`\n\nBoolean specifying whether any files were formatted using the remark-lint linter.\n\n## Advanced use cases\n\n### Annotate changes\n\nThis action can be combined with [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester) also to annotate any possible changes (uses `git diff`).\n\n```yaml\nname: remark-lint-action\non: [push, pull_request]\njobs:\n  name: runner / remark-lint\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v2\n    - name: Check files using the remark-lint linter\n      uses: rickstaa/action-remark-lint@v1\n      id: action_remark_lint\n      with:\n        remark_args: \". -o\"\n    - name: Annotate diff changes using reviewdog\n      if: steps.action_remark_lint.outputs.is_formatted == 'true'\n      uses: reviewdog/action-suggester@v1\n      with:\n        tool_name: remarkfmt\n```\n\n### Commit changes or create a pull request\n\nThis action can be combined with [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) to also apply the annotated changes to the repository.\n\n```yaml\nname: remark-lint-action\non: [push, pull_request]\njobs:\n  name: runner / remark-lint\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v2\n    - name: Check files using remark-lint linter\n      uses: rickstaa/action-remark-lint@v1\n      id: action_remark_lint\n      with:\n        remark_args: \". -o\"\n    - name: Create Pull Request\n      if: steps.action_remark_lint.outputs.is_formatted == 'true'\n      uses: peter-evans/create-pull-request@v3\n      with:\n        token: ${{ secrets.GITHUB_TOKEN }}\n        title: \"Format Python code with remark-lint linter\"\n        commit-message: \":art: Format Python code with remark-lint\"\n        body: |\n          There appear to be some python formatting errors in ${{ github.sha }}. This pull request\n          uses the [remark-lint](https://github.com/remarkjs/remark-lint) linter to fix these issues.\n        base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch\n        branch: actions/remark-lint\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickstaa%2Faction-remark-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frickstaa%2Faction-remark-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickstaa%2Faction-remark-lint/lists"}