https://github.com/sslime-s/traq-webhook

traQ に github actions + webhook を用いて投稿するようのやつ
https://github.com/sslime-s/traq-webhook

Last synced: 3 days ago
JSON representation

traQ に github actions + webhook を用いて投稿するようのやつ

• Host: GitHub
• URL: https://github.com/sslime-s/traq-webhook
• Owner: SSlime-s
• Created: 2021-06-12T06:58:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-21T07:24:42.000Z (about 2 months ago)
• Last Synced: 2024-12-21T07:26:05.289Z (about 2 months ago)
• Language: JavaScript
• Size: 714 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# traq-webhook

traQ に github actions +  webhook を用いて投稿するようのやつ

## 入力

### `webhook-id`

**必須** Webhook の ID

### `webhook-secret`

Webhook の Secret (Secure Webhookの場合必須)

### `channel-id`

投稿先のチャンネル (入力しなければデフォルトのチャンネル)

### `message`

投稿するメッセージ (`auto-generate-message` が true の場合は無視されます)

`auto-generate-message` が false もしくは未指定の場合は必須です

### `auto-generate-message`

true にすると自動生成されたメッセージを投稿します (`message` は無視されます)

### `embed`

true にすると埋め込みが有効になります

## 使用例

### メッセージの自動生成を利用する場合

```

on:

  issues:

    types: [opened, edited, closed, reopened]

  issue_comment:

    types: [created, edited]

  pull_request:

    types: [opened, edited, closed, review_requested]

  pull_request_review:

    types: [submitted]

  release:

    types: [released]

  create

permissions: read-all

jobs:

  webhook:

    runs-on: ubuntu-latest

    steps:

    - name: post to traQ

      uses: SSlime-s/traq-webhook@v5

      with:

        webhook-id: ${{ secrets.WEBHOOK_ID }}

        webhook-secret: ${{ secrets.WEBHOOK_SECRET }}

        auto-generate-message: true

```

### メッセージを指定する場合

```

on:

  your-event

jobs:

  webhook:

    runs-on: ubuntu-latest

    steps:

    - name: post to traQ

      uses: SSlime-s/traq-webhook@v5

      with:

        webhook-id: ${{ secrets.WEBHOOK_ID }}

        webhook-secret: ${{ secrets.WEBHOOK_SECRET }}

        message: 'Hello, world!'

        embed: true

```