Skip to content

Latest commit

 

History

History
128 lines (118 loc) · 3.81 KB

README.md

File metadata and controls

128 lines (118 loc) · 3.81 KB

🐤 Latest tweets

This plugin displays the latest tweets from your Twitter account.

Supported features
→ Full specification
📗 Classic template 📒 Markdown template
👤 Users 👥 Organizations
🗝️ plugin_tweets_token
Latest tweets with attachments
Latest tweets

➡️ Available options

TypeDescription
plugin_tweets

Enable tweets plugin

type: boolean
default: no
plugin_tweets_token

Twitter API token

🔐 Token
type: token
plugin_tweets_attachments

Display tweets attachments (images, video previews, etc.)

type: boolean
default: no
plugin_tweets_limit

Display limit

type: number (1 ≤ 𝑥 ≤ 10)
default: 2
plugin_tweets_user

Twitter username

⏯️ Cannot be preset
type: string
default: → User attached twitter

🗝️ 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.

Twitter token

ℹ️ 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