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

Option	Type (format) [default] {allowed values}	Description
plugin_tweets	boolean [no]	Display recent tweets
plugin_tweets_token 🔐	token []	Twitter API token
plugin_tweets_attachments	boolean [no]	Display tweets attchments
plugin_tweets_limit	number [2] {1 ≤ 𝑥 ≤ 10}	Maximum number of tweets to display
plugin_tweets_user	string [→ User attached twitter]	Twitter username

Legend for option icons:

• 🔐 Value should be stored in repository secrets

→ Full specification

ℹ️ Examples workflows

name: Latest tweets
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.tweets.svg
  token: NOT_NEEDED
  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
  plugin_tweets: 'yes'
  plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
  plugin_tweets_attachments: 'yes'
  plugin_tweets_user: github