https://github.com/scrum/awesome-lint-action
A GitHub Action that lint awesome readme in PR
https://github.com/scrum/awesome-lint-action
List: awesome-lint-action
Last synced: 5 months ago
JSON representation
A GitHub Action that lint awesome readme in PR
- Host: GitHub
- URL: https://github.com/scrum/awesome-lint-action
- Owner: Scrum
- Created: 2020-07-23T07:26:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T12:15:16.000Z (over 3 years ago)
- Last Synced: 2025-04-04T23:08:41.313Z (about 1 year ago)
- Language: JavaScript
- Size: 1.69 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# 
Awesome readme lint
> A GitHub Action that lint awesome readme in PR
## Usage
You can create a `.github/workflows/awesome-lint.yml` file:
```yaml
name: Awesome readme lint
on:
pull_request:
types: [opened, synchronize]
branches:
- master
jobs:
build:
name: awesome readme lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: Scrum/awesome-lint-action@v0.1.0
with:
entry: 'path/to/file'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Related
- [awesome-lint](https://github.com/sindresorhus/awesome-lint) - Linter for Awesome lists.