Skip to content

Commit

Permalink
docs: update doc about language
Browse files Browse the repository at this point in the history
  • Loading branch information
roseline124 committed Jun 30, 2024
1 parent 7be57da commit 37783f3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
3 changes: 3 additions & 0 deletions KOREAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ jobs:
slack_token: ${{ secrets.SLACK_TOKEN }}
slack_channel: <SLACK_CHANNEL_ID>
slack_workspace: <SLACK_WORKSPACE_NAME>
language: ko
```
3. 프로젝트 루트 레벨에 `reviewers.yml` 파일을 만들어주세요. 아래 포맷을 꼭 지켜주세요.
Expand Down Expand Up @@ -105,6 +106,7 @@ jobs:
slack_channel: <SLACK_CHANNEL_ID>
slack_workspace: <SLACK_WORKSPACE_NAME>
reviewers_file: <CUSTOM_FILE_PATH>
language: ko
```

4. input 관련 설명
Expand All @@ -119,6 +121,7 @@ jobs:
| slack_merge_emoji_name | PR 머지 시에 슬랙 메시지에 이모지가 붙습니다. | false | white_check_mark |
| slack_close_emoji_name | PR 클로즈 시에 슬랙 메시지에 이모지가 붙습니다. | false | x |
| emergency_label_name | PR 오픈 시에 이 라벨이 있으면 긴급 메시지가 붙습니다. | false | emergency |
| language | 언어 설정 (ex. `en`, `ko`)want | false | en |

## test action

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Integrate PR review activities into Slack with GitHub actions without a webhook server. All you need to do is add a github action workflow.

english is default.

![Preview Image](images/preview.png)

## korean document
Expand Down Expand Up @@ -67,7 +69,6 @@ jobs:
slack_token: ${{ secrets.SLACK_TOKEN }}
slack_channel: <SLACK_CHANNEL_ID>
slack_workspace: <SLACK_WORKSPACE_NAME>
language: ko
```
3. create a `reviewers.yml` file in the root of your project. Please make sure to follow this format.
Expand Down Expand Up @@ -111,7 +112,6 @@ jobs:
slack_channel: <SLACK_CHANNEL_ID>
slack_workspace: <SLACK_WORKSPACE_NAME>
reviewers_file: <CUSTOM_FILE_PATH>
language: ko
```

4. about inputs
Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ inputs:
runs:
using: "node20"
main: "dist/index.js"

branding:
color: "blue"
icon: "message-square"

0 comments on commit 37783f3

Please sign in to comment.