github-action-notify-twitter's Introduction

Github Action to send Twitter notifications

GitHub action that can send a custom message to a Twitter account.

Usage

Configure this action in your workflows providing the following inputs described below. The Twitter tokens can be obtained from the Twitter Developer Portal under your project.

Inputs

input	required	description
`message`	yes	Message to post to Twitter.
`twitter-app-key`	yes	Consumer API key, available in the "Keys and tokens" section of your application in the Twitter Developer site.
`twitter-app-secret`	yes	Consumer API secret key, available in the "Keys and tokens" section of your application in the Twitter Developer site.
`twitter-access-token`	yes	Application access token, available in the "Keys and tokens" section of your application in the Twitter Developer site.
`twitter-access-token-secret`	yes	Application access token secret, available in the "Keys and tokens" section of your application in the Twitter Developer site.

Example usage

The example below runs when the release is published and also allows to trigger the action manually.

name: Notify twitter

on:
  workflow_dispatch:
  release:
    types: [published]

jobs:
  setup:
    runs-on: ubuntu-latest
    steps:
      - uses: nearform-actions/github-action-notify-twitter@master
        with:
          message: |
            ${{ github.event.repository.name }} ${{ github.event.release.tag_name }} has been released. Check out the release notes: ${{ github.event.release.html_url }}
          twitter-app-key: ${{ secrets.TWITTER_APP_KEY }}
          twitter-app-secret: ${{ secrets.TWITTER_APP_SECRET }}
          twitter-access-token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
          twitter-access-token-secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}

Recommend Projects