https://github.com/okuzawats/chatwork-task-action

Chatworkのタスクを作成するActionです。
https://github.com/okuzawats/chatwork-task-action

chatwork ruby

Last synced: about 1 year ago
JSON representation

Chatworkのタスクを作成するActionです。

• Host: GitHub
• URL: https://github.com/okuzawats/chatwork-task-action
• Owner: okuzawats
• License: mit
• Created: 2024-07-15T07:13:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-20T20:45:33.000Z (almost 2 years ago)
• Last Synced: 2025-04-01T12:56:20.185Z (about 1 year ago)
• Topics: chatwork, ruby
• Language: Ruby
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Chatwork Task Action

[![actionlint](https://github.com/okuzawats/chatwork-task-action/actions/workflows/actionlint.yml/badge.svg)](https://github.com/okuzawats/chatwork-task-action/actions/workflows/actionlint.yml)

[![yamllint](https://github.com/okuzawats/chatwork-task-action/actions/workflows/yamllint.yml/badge.svg)](https://github.com/okuzawats/chatwork-task-action/actions/workflows/yamllint.yml)

[![rubocop](https://github.com/okuzawats/chatwork-task-action/actions/workflows/rubocop.yml/badge.svg)](https://github.com/okuzawats/chatwork-task-action/actions/workflows/rubocop.yml)

Chatworkのタスクを作成するActionです。指定したルームの、指定したユーザーにタスクを割り当てます。

## 使い方

以下のように使用します。

```yml

- uses: okuzawats/chatwork-task-action@v1.0 # またはコミットハッシュを使用してください。

  with:

    # ChatworkのAPIキー

    apiToken: "${{ secrets.API_KEY }}"

    # タスクを作成するルームID

    roomId: "${{ secrets.ROOM_ID }}"

    # タスクを割り当てるユーザーID（カンマ区切りで複数指定可能）

    userIds: "${{ secrets.USER_ID }}"

    # タスク本文

    body: "get some milk for me."

```

## APIトークン

[Chatwork API へようこそ！](https://developer.chatwork.com/docs)から「API の利用申請」を行い、発行されたトークンです。本Actionで作成されるタスクは、このトークンを発行したユーザーによって作成されたタスクとなります。このトークンを作成したユーザーは、タスクを作成するルームのメンバーであり、ルームで投稿する権限を持つ必要があります。

## ルームID

以下から取得できるIDです。

- チャットの説明 > グループチャットの設定 > チャット情報 > 画面下部のルームID

## ユーザーID

自分宛に返信した時に `aid=XXXXXXX` と表示される `XXXXXXX` の部分のIDです。

## メッセージ記法

`body` ではメッセージ記法を利用可能です。Chatworkのメッセージ記法については、以下を参照してください。

- [メッセージ記法について](https://developer.chatwork.com/docs/message-notation)