Skip to content

Commit eec4d3d

Browse files
committed
Updated readme
1 parent 14d03d3 commit eec4d3d

File tree

1 file changed

+20
-38
lines changed

1 file changed

+20
-38
lines changed

README.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
# action-template
2-
3-
<!-- TODO: replace reviewdog/action-template with your repo name -->
4-
[![Test](https://github.com/reviewdog/action-template/workflows/Test/badge.svg)](https://github.com/reviewdog/action-template/actions?query=workflow%3ATest)
5-
[![reviewdog](https://github.com/reviewdog/action-template/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-template/actions?query=workflow%3Areviewdog)
6-
[![depup](https://github.com/reviewdog/action-template/workflows/depup/badge.svg)](https://github.com/reviewdog/action-template/actions?query=workflow%3Adepup)
7-
[![release](https://github.com/reviewdog/action-template/workflows/release/badge.svg)](https://github.com/reviewdog/action-template/actions?query=workflow%3Arelease)
8-
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-template?logo=github&sort=semver)](https://github.com/reviewdog/action-template/releases)
1+
# action-haml-lint
2+
3+
4+
[![Test](https://github.com/84codes/action-haml-lint/workflows/Test/badge.svg)](https://github.com/84codes/action-haml-lint/actions?query=workflow%3ATest)
5+
[![reviewdog](https://github.com/84codes/action-haml-lint/workflows/reviewdog/badge.svg)](https://github.com/84codes/action-haml-lint/actions?query=workflow%3Areviewdog)
6+
[![depup](https://github.com/84codes/action-haml-lint/workflows/depup/badge.svg)](https://github.com/84codes/action-haml-lint/actions?query=workflow%3Adepup)
7+
[![release](https://github.com/84codes/action-haml-lint/workflows/release/badge.svg)](https://github.com/84codes/action-haml-lint/actions?query=workflow%3Arelease)
8+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/84codes/action-haml-lint?logo=github&sort=semver)](https://github.com/84codes/action-haml-lint/releases)
99
[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)
1010

11-
![github-pr-review demo](https://user-images.githubusercontent.com/3797062/73162963-4b8e2b00-4132-11ea-9a3f-f9c6f624c79f.png)
12-
![github-pr-check demo](https://user-images.githubusercontent.com/3797062/73163032-70829e00-4132-11ea-8481-f213a37db354.png)
11+
---
12+
This action will run [haml-lint](https://github.com/sds/haml-lint) together with [reviewdog](https://github.com/reviewdog/reviewdog) to create a nice report on your pull requests.
13+
14+
This action was created using the [action-template](https://github.com/reviewdog/action-template) created by the reviewdog team.
1315

14-
This is a template repository for [reviewdog](https://github.com/reviewdog/reviewdog) action with release automation.
15-
Click `Use this template` button to create your reviewdog action :dog:!
16+
---
1617

17-
If you want to create your own reviewdog action from scratch without using this
18-
template, please check and copy release automation flow.
19-
It's important to manage release workflow and sync reviewdog version for all
20-
reviewdog actions.
2118

22-
This repo contains a sample action to run [misspell](https://github.com/client9/misspell).
19+
### Example
20+
![github-pr-review demo](https://user-images.githubusercontent.com/9164583/81692519-d0d9e900-945e-11ea-9557-59fb3305665e.png)
21+
22+
<!-- TODO: Add image like above for github-pr-check reporter -->
2323

2424
## Input
2525

26-
<!-- TODO: update -->
2726
```yaml
2827
inputs:
2928
github_token:
@@ -52,26 +51,20 @@ inputs:
5251
reviewdog_flags:
5352
description: 'Additional reviewdog flags'
5453
default: ''
55-
### Flags for <linter-name> ###
56-
locale:
57-
description: '-locale flag of misspell. (US/UK)'
58-
default: ''
5954
```
6055
6156
## Usage
62-
<!-- TODO: update. replace `template` with the linter name -->
6357
6458
```yaml
6559
name: reviewdog
6660
on: [pull_request]
6761
jobs:
68-
# TODO: change `linter_name`.
6962
linter_name:
70-
name: runner / <linter-name>
63+
name: runner / haml-lint
7164
runs-on: ubuntu-latest
7265
steps:
7366
- uses: actions/checkout@v2
74-
- uses: reviewdog/action-template@v1
67+
- uses: 84codes/action-haml-lint@v1
7568
with:
7669
github_token: ${{ secrets.github_token }}
7770
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
@@ -82,6 +75,7 @@ jobs:
8275
```
8376
8477
## Development
78+
Fork the repo, make a feature branch, implement your feature, create a pullrequest.
8579
8680
### Release
8781
@@ -94,18 +88,6 @@ Pushing tag manually by yourself also work.
9488
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
9589
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
9690
97-
### Lint - reviewdog integration
98-
99-
This reviewdog action template itself is integrated with reviewdog to run lints
100-
which is useful for Docker container based actions.
101-
102-
![reviewdog integration](https://user-images.githubusercontent.com/3797062/72735107-7fbb9600-3bde-11ea-8087-12af76e7ee6f.png)
103-
104-
Supported linters:
105-
106-
- [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck)
107-
- [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint)
108-
- [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell)
10991
11092
### Dependencies Update Automation
11193
This repository uses [haya14busa/action-depup](https://github.com/haya14busa/action-depup) to update

0 commit comments

Comments
 (0)