Skip to content

Commit

Permalink
deprecate task feature (#51)
Browse files Browse the repository at this point in the history
* deprecated messageType

* deprecate userIdsToAssignTask

* update README to warn deprecated feature

* remove development step for task feature
  • Loading branch information
okuzawats authored Jul 20, 2024
1 parent 80cf58f commit 49e7182
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
7 changes: 0 additions & 7 deletions .github/workflows/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,3 @@ jobs:
apiToken: "${{ secrets.API_KEY }}"
roomId: "${{ secrets.ROOM_ID }}"
message: "${{ env.MESSAGE }}"
- uses: ./
with:
apiToken: "${{ secrets.API_KEY }}"
roomId: "${{ secrets.ROOM_ID }}"
message: "this is your task"
messageType: "task"
userIdsToAssignTask: "${{ secrets.USER_ID_1 }}"
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ Chatwork の Room にメッセージを送信する Action です。
message: 'ここにメッセージを書きます。'
```
> [!WARNING]
> v1.1で導入されたタスク機能は、将来のバージョンから削除されます。代わりに[okuzawats/chatwork-task-action](https://github.com/okuzawats/chatwork-task-action)を使用してください。
タスク機能にも対応しました(v1.1〜)。`messageType` と `userIdsToAssignTask` を追加してください。`userIdsToAssignTask` には複数IDを指定できます。カンマ区切りでユーザーIDを指定してください。

```yml
Expand Down
7 changes: 7 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ inputs:
roomId:
required: true
description: "Chatroom ID"
# deprecated inputs. this inputs parameter will be removed in the future version.
messageType:
description: "Message type to send. default is message."
type: "choice"
Expand All @@ -23,6 +24,7 @@ inputs:
message:
required: true
description: "Message to send"
# deprecated inputs. this inputs parameter will be removed in the future version.
userIdsToAssignTask:
required: false
description: "User Id to be assigned to the task. Or you can specify multiple users, separated by commas. example 1,3,5"
Expand All @@ -36,6 +38,11 @@ runs:
fetch-depth: 0
- name: "set up ruby"
uses: "ruby/setup-ruby@v1"
- name: "deprecate messageType"
if: ${{ !github.event.inputs.messageType }}
run: |
echo "::warning::messageType is now deprecated. If you use only message, just remove the parameter. Or if you use task, please use okuzawats/chatwork-task-action instead. In this case, remove userIdsToAssignTask parameter also."
shell: "sh"
- name: "run action"
run: |
ruby $GITHUB_ACTION_PATH/main.rb
Expand Down

0 comments on commit 49e7182

Please sign in to comment.