/chatwork-messaging-action

Chatwork の Room にメッセージを送信する Action です。

Primary LanguageRubyMIT LicenseMIT

Chatwork messaging action

actionlint rubocop yamllint

Chatwork の Room にメッセージを送信する Action です。

以下の Chatwork API を使用しています。

使い方

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

- uses: okuzawats/chatwork-messaging-action@v1.1 # またはコミットハッシュを使用してください。
  with:
    apiToken: ${{ secrets.API_KEY }} # Chatwork の API キーです。secrets の利用を推奨します。
    roomId: ${{ secrets.ROOM_ID }} # Chatwork の Room ID です。secrets の利用を推奨します。
    message: 'ここにメッセージを書きます。'

タスク機能にも対応しました（v1.1〜）。messageType と userIdsToAssignTask を追加してください。userIdsToAssignTask には複数IDを指定できます。カンマ区切りでユーザーIDを指定してください。

- uses: okuzawats/chatwork-messaging-action@v1.1 # またはコミットハッシュを使用してください。
  with:
    apiToken: ${{ secrets.API_KEY }} # Chatwork の API キーです。secrets の利用を推奨します。
    roomId: ${{ secrets.ROOM_ID }} # Chatwork の Room ID です。secrets の利用を推奨します。
    message: '牛乳を買う'
    messageType: 'task'
    userIdsToAssignTask: USER_ID

ワークフロー構文の書き方は、本リポジトリの .github/workflows/ 内に格納してある、example.ymlも参考にしてください。

Chatwork の使い方

API トークン

Chatwork API へようこそ！から「API の利用申請」を行い、発行された ID です。この ID を用いて投稿されたチャットは、この ID を発行したユーザーのチャットとして扱われます。

ルーム ID

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

または

  • Web 版でチャットルームを開いた時、URL に含まれる rid 以下の数字

です。

ユーザー ID

  • 自分宛に返信した時に aid=XXXXXXX と表示される XXXXXXX の部分

メッセージ記法

Chatwork のメッセージ記法については、以下を参照してください。

バグ報告

本リポジトリに Issue を作成してください。どのような状況で、どのようなバグが発生したのかを教えてください 🙇