metrics/source/plugins/tweets/README.md

🐤 Tweets

The recent tweets plugin displays your latest tweets from your Twitter account.

Latest tweets Latest tweets with attachments

💬 Obtaining a Twitter token

To get a Twitter token, you'll need to apply to the developer program. It's a bit tedious, but it seems that requests are approved quite quickly.

Create an app from your developer dashboard and register your bearer token in your repository secrets.

➡️ Available options

Type	Description
plugin_tweets	Display recent tweets
type: boolean default: no
plugin_tweets_token	Twitter API token
🔐 Token type: token
plugin_tweets_attachments	Display tweets attchments
type: boolean default: no
plugin_tweets_limit	Maximum number of tweets to display
type: number (1 ≤ 𝑥 ≤ 10) default: 2
plugin_tweets_user	Twitter username
type: string default: → User attached twitter

→ Full specification

ℹ️ Examples workflows

name: Latest tweets
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.tweets.svg
  token: NOT_NEEDED
  base: ''
  plugin_tweets: 'yes'
  plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
  plugin_tweets_user: github

name: Latest tweets including attachments
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.tweets.attachments.svg
  token: NOT_NEEDED
  base: ''
  plugin_tweets: 'yes'
  plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
  plugin_tweets_attachments: 'yes'
  plugin_tweets_user: github