Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rickstaa/action-remark-lint
Runs the remark-lint linter to check/format your python code.
https://github.com/rickstaa/action-remark-lint
codequality continious-integration docker formatter gh-action github-actions github-actions-docker linter markdown
Last synced: 27 days ago
JSON representation
Runs the remark-lint linter to check/format your python code.
- Host: GitHub
- URL: https://github.com/rickstaa/action-remark-lint
- Owner: rickstaa
- License: mit
- Created: 2021-01-07T10:41:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T14:18:05.000Z (about 1 year ago)
- Last Synced: 2024-09-10T01:11:52.142Z (about 2 months ago)
- Topics: codequality, continious-integration, docker, formatter, gh-action, github-actions, github-actions-docker, linter, markdown
- Language: Shell
- Homepage: https://github.com/marketplace/actions/run-remark-lint
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Action-remark-lint GitHub Action
[](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3ATest)
[](https://github.com/rickstaa/action-remark-lint/actions?query=workflow%3Arelease)
[](https://github.com/rickstaa/action-remark-lint/releases)
[](https://github.com/haya14busa/action-bumpr)
This action runs the [remark-lint linter](https://github.com/remarkjs/remark-lint) to check/format your markdown code on a push or pull request.
## Quickstart
```yml
name: remark-lint-action
on: [push, pull_request]
jobs:
remark-lint:
name: runner / remark-lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: remark-lint
uses: rickstaa/action-remark-lint@v1
```
## Inputs
### `remark_args`
**optional**: Remark-lint input arguments. Defaults to `. --frail --quiet`.
### `fail_on_error`
**optional**: Exit code when remark-lint linting errors are found \[true, false]. Defaults to 'true'.
## Outputs
### `is_formatted`
Boolean specifying whether any files were formatted using the remark-lint linter.
## Advanced use cases
### Annotate changes
This action can be combined with [reviewdog/action-suggester](https://github.com/reviewdog/action-suggester) also to annotate any possible changes (uses `git diff`).
```yaml
name: remark-lint-action
on: [push, pull_request]
jobs:
name: runner / remark-lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Check files using the remark-lint linter
uses: rickstaa/action-remark-lint@v1
id: action_remark_lint
with:
remark_args: ". -o"
- name: Annotate diff changes using reviewdog
if: steps.action_remark_lint.outputs.is_formatted == 'true'
uses: reviewdog/action-suggester@v1
with:
tool_name: remarkfmt
```
### Commit changes or create a pull request
This 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.
```yaml
name: remark-lint-action
on: [push, pull_request]
jobs:
name: runner / remark-lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Check files using remark-lint linter
uses: rickstaa/action-remark-lint@v1
id: action_remark_lint
with:
remark_args: ". -o"
- name: Create Pull Request
if: steps.action_remark_lint.outputs.is_formatted == 'true'
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
title: "Format Python code with remark-lint linter"
commit-message: ":art: Format Python code with remark-lint"
body: |
There appear to be some python formatting errors in ${{ github.sha }}. This pull request
uses the [remark-lint](https://github.com/remarkjs/remark-lint) linter to fix these issues.
base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch
branch: actions/remark-lint
```