Skip to content

Commit cf0e9cc

Browse files
committed
Update the readme
1 parent b6193b2 commit cf0e9cc

File tree

1 file changed

+20
-32
lines changed

1 file changed

+20
-32
lines changed

README.md

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# action-haml-lint
22

33

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)
4+
[![Test](https://github.com/patch-technology/action-haml-lint/workflows/Test/badge.svg)](https://github.com/patch-technology/action-haml-lint/actions?query=workflow%3ATest)
5+
[![reviewdog](https://github.com/patch-technology/action-haml-lint/workflows/reviewdog/badge.svg)](https://github.com/patch-technology/action-haml-lint/actions?query=workflow%3Areviewdog)
6+
[![depup](https://github.com/patch-technology/action-haml-lint/workflows/depup/badge.svg)](https://github.com/patch-technology/action-haml-lint/actions?query=workflow%3Adepup)
7+
[![release](https://github.com/patch-technology/action-haml-lint/workflows/release/badge.svg)](https://github.com/patch-technology/action-haml-lint/actions?query=workflow%3Arelease)
8+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/patch-technology/action-haml-lint?logo=github&sort=semver)](https://github.com/patch-technology/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

1111
---
@@ -15,13 +15,12 @@ This action was created using the [action-template](https://github.com/reviewdog
1515

1616
---
1717

18-
1918
### Example
2019
![github-pr-review demo](https://user-images.githubusercontent.com/9164583/81692519-d0d9e900-945e-11ea-9557-59fb3305665e.png)
2120

2221
<!-- TODO: Add image like above for github-pr-check reporter -->
2322

24-
## Input
23+
## Inputs
2524

2625
```yaml
2726
inputs:
@@ -31,6 +30,16 @@ inputs:
3130
workdir:
3231
description: 'Working directory relative to the root directory.'
3332
default: '.'
33+
### Flags for haml-lint
34+
haml_lint_flags:
35+
description: 'Additional haml-lint flags'
36+
default: ''
37+
### Flags for rubocop
38+
rubocop_version:
39+
description: 'The rubocop version to install. Choose `gemfile` to use the version from your gemfile'
40+
rubocop_extensions:
41+
description: 'Rubocop extensions to install'
42+
default: 'rubocop-rails rubocop-performance rubocop-rspec rubocop-i18n rubocop-rake'
3443
### Flags for reviewdog ###
3544
level:
3645
description: 'Report level for reviewdog [info,warning,error]'
@@ -51,10 +60,6 @@ inputs:
5160
reviewdog_flags:
5261
description: 'Additional reviewdog flags'
5362
default: ''
54-
### Flags for haml-lint
55-
haml_lint_flags:
56-
description: 'Additional haml-lint flags'
57-
default: ''
5863
```
5964
6065
## Usage
@@ -68,35 +73,18 @@ jobs:
6873
runs-on: ubuntu-latest
6974
steps:
7075
- uses: actions/checkout@v3
71-
- uses: 84codes/action-haml-lint@v1
76+
- uses: patch-technology/action-haml-lint@v1
7277
with:
7378
github_token: ${{ secrets.github_token }}
7479
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
7580
reporter: github-pr-review
7681
# Change reporter level if you need.
7782
# GitHub Status Check won't become failure with warning.
7883
level: warning
84+
# Change the config file and other haml-lint flags
7985
haml_lint_flags: -c .haml-config.yml
86+
# Set the rubocop version to the one from your Gemfile
87+
rubocop_version: gemfile
8088
```
8189
82-
## Development
83-
Fork the repo, make a feature branch, implement your feature, create a pull request.
84-
85-
### Release
86-
87-
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
88-
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
89-
Pushing tag manually by yourself also work.
90-
91-
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
92-
93-
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
94-
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
95-
96-
97-
### Dependencies Update Automation
98-
This repository uses [haya14busa/action-depup](https://github.com/haya14busa/action-depup) to update
99-
reviewdog version.
100-
101-
[![reviewdog depup demo](https://user-images.githubusercontent.com/3797062/73154254-170e7500-411a-11ea-8211-912e9de7c936.png)](https://github.com/reviewdog/action-template/pull/6)
10290

0 commit comments

Comments
 (0)