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

Chatwork の Room にメッセージを送信する Action です。
https://github.com/okuzawats/chatwork-messaging-action

chatwork github-actions githubactions ruby

Last synced: 8 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/okuzawats/chatwork-messaging-action
• Owner: okuzawats
• License: mit
• Created: 2022-08-31T01:07:17.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T04:37:59.000Z (almost 2 years ago)
• Last Synced: 2025-02-07T00:42:50.666Z (over 1 year ago)
• Topics: chatwork, github-actions, githubactions, ruby
• Language: Ruby
• Homepage:
• Size: 48.8 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Chatwork messaging action

[![actionlint](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/actionlint.yml/badge.svg?branch=main)](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/actionlint.yml)

[![rubocop](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/rubocop.yml/badge.svg?event=pull_request)](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/rubocop.yml)

[![yamllint](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/yamllint.yml/badge.svg?branch=main)](https://github.com/okuzawats/chatwork-messaging-action/actions/workflows/yamllint.yml)

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

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

- https://developer.chatwork.com/reference/post-rooms-room_id-messages

## 使い方

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

```yml

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

  with:

    apiToken: ${{ secrets.API_KEY }} # Chatwork の API キーです。secrets の利用を推奨します。

    roomId: ${{ secrets.ROOM_ID }} # Chatwork の Room ID です。secrets の利用を推奨します。

    message: 'ここにメッセージを書きます。'

```

ワークフロー構文の書き方は、本リポジトリの `.github/workflows/` 内に格納してある、[example.yml](https://github.com/okuzawats/chatwork-messaging-action/blob/main/.github/workflows/example.yml)も参考にしてください。

## Chatwork の使い方

### API トークン

[Chatwork API へようこそ！](https://developer.chatwork.com/docs)から「API の利用申請」を行い、発行された ID です。この ID を用いて投稿されたチャットは、この ID を発行したユーザーのチャットとして扱われます。

### ルーム ID

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

または

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

です。

### ユーザー ID

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

### メッセージ記法

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

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

## バグ報告

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