metrics/source/plugins/tweets/README.md

← Back to plugins index
🐤 Latest tweets
This plugin displays the latest tweets from a Twitter account.
Supported features → Full specification	📗 Classic template 📒 Markdown template
	👤 Users 👥 Organizations
	🗝️ plugin_tweets_token
Latest tweets with attachments Latest tweets

➡️ Available options

Option	Description
plugin_tweets	Enable tweets plugin
🌐 Web instances must configure settings.json: metrics.api.twitter.tweets type: boolean default: no
plugin_tweets_token	Twitter API token
🔐 Token type: token
plugin_tweets_user	Twitter username
⏯️ Cannot be preset type: string default: → User attached twitter
plugin_tweets_attachments	Tweets attachments Can be used to display linked images, video thumbnails, etc.
type: boolean default: no
plugin_tweets_limit	Display limit
type: number (1 ≤ 𝑥 ≤ 10) default: 2

🗝️ Obtaining a Twitter token

To get a Twitter token, it is required to apply to the developer program. It's a bit tedious, but requests seems to be approved quite quickly.

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

ℹ️ 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
  plugin_tweets_limit: 1