chore: deprecate tweets plugin

2023-07-24 13:22:15 -04:00
parent 96dde98a03
commit fca0e34e9d
7 changed files with 34 additions and 83 deletions
--- a/.github/workflows/examples.yml
+++ b/.github/workflows/examples.yml
@@ -874,36 +874,6 @@ jobs:
          user: lowlighter
          plugins_errors_fatal: yes
        if: ${{ success() || failure() }}
-      - name: 🐤 Latest tweets - Latest tweets
-        uses: lowlighter/metrics@master
-        with:
-          filename: metrics.plugin.tweets.svg
-          token: NOT_NEEDED
-          base: ""
-          plugin_tweets: yes
-          plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
-          plugin_tweets_user: github
-          output_action: none
-          delay: 120
-          user: lowlighter
-          plugins_errors_fatal: yes
-        if: ${{ success() || failure() }}
-      - name: 🐤 Latest tweets - Latest tweets including attachments
-        uses: lowlighter/metrics@master
-        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
-          output_action: none
-          delay: 120
-          user: lowlighter
-          plugins_errors_fatal: yes
-        if: ${{ success() || failure() }}
      - name: 🗨️ Stack Overflow - Top answers from stackoverflow
        uses: lowlighter/metrics@master
        with:
--- a/README.md
+++ b/README.md
@@ -243,77 +243,65 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
      </td>
  </tr>
  <tr>
-    <th><a href="source/plugins/tweets/README.md">🐤 Latest tweets</a></th>
    <th><a href="source/plugins/stackoverflow/README.md">🗨️ Stack Overflow</a></th>
+    <th><a href="source/plugins/anilist/README.md">🌸 Anilist watch list and reading list</a></th>
  </tr>
  <tr>
-        <td  align="center">
-        <details open><summary>Latest tweets with attachments</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg" alt=""></img></details>
-        <details><summary>Latest tweets</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg" alt=""></img></details>
-        <img width="900" height="1" alt="">
-      </td>
        <td  align="center">
        <img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stackoverflow.svg" alt=""></img>
        <img width="900" height="1" alt="">
      </td>
-  </tr>
-  <tr>
-    <th><a href="source/plugins/anilist/README.md">🌸 Anilist watch list and reading list</a></th>
-    <th><a href="source/plugins/music/README.md">🎼 Music activity and suggestions</a></th>
-  </tr>
-  <tr>
        <td  align="center">
        <details open><summary>For anime watchers</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg" alt=""></img></details>
        <details><summary>For manga readers</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg" alt=""></img></details>
        <details open><summary>For waifus simp</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg" alt=""></img></details>
        <img width="900" height="1" alt="">
      </td>
+  </tr>
+  <tr>
+    <th><a href="source/plugins/music/README.md">🎼 Music activity and suggestions</a></th>
+    <th><a href="source/plugins/posts/README.md">✒️ Recent posts</a></th>
+  </tr>
+  <tr>
        <td  align="center">
        <details open><summary>Random tracks from a playlist</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.playlist.svg" alt=""></img></details>
        <details open><summary>Recently listened</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.recent.svg" alt=""></img></details>
        <img width="900" height="1" alt="">
      </td>
-  </tr>
-  <tr>
-    <th><a href="source/plugins/posts/README.md">✒️ Recent posts</a></th>
-    <th><a href="source/plugins/rss/README.md">🗼 Rss feed</a></th>
-  </tr>
-  <tr>
        <td  align="center">
        <details open><summary>Latest posts width description and cover image</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.full.svg" alt=""></img></details>
        <details><summary>Latest posts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.svg" alt=""></img></details>
        <img width="900" height="1" alt="">
      </td>
+  </tr>
+  <tr>
+    <th><a href="source/plugins/rss/README.md">🗼 Rss feed</a></th>
+    <th><a href="source/plugins/wakatime/README.md">⏰ WakaTime</a></th>
+  </tr>
+  <tr>
        <td  align="center">
        <img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.rss.svg" alt=""></img>
        <img width="900" height="1" alt="">
      </td>
-  </tr>
-  <tr>
-    <th><a href="source/plugins/wakatime/README.md">⏰ WakaTime</a></th>
-    <th><a href="source/plugins/leetcode/README.md">🗳️ Leetcode</a></th>
-  </tr>
-  <tr>
        <td  align="center">
        <img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.wakatime.svg" alt=""></img>
        <img width="900" height="1" alt="">
      </td>
+  </tr>
+  <tr>
+    <th><a href="source/plugins/leetcode/README.md">🗳️ Leetcode</a></th>
+    <th><a href="source/plugins/steam/README.md">🕹️ Steam</a></th>
+  </tr>
+  <tr>
        <td  align="center">
        <img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.leetcode.svg" alt=""></img>
        <img width="900" height="1" alt="">
      </td>
-  </tr>
-  <tr>
-    <th><a href="source/plugins/steam/README.md">🕹️ Steam</a></th>
-    <th></th>
-  </tr>
-  <tr>
        <td  align="center">
        <details open><summary>Recently played games</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.svg" alt=""></img></details>
        <details><summary>Profile and detailed game history</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.full.svg" alt=""></img></details>
        <img width="900" height="1" alt="">
      </td>
-    <td align="center"><img width="900" height="1" alt=""></td>
  </tr>
  <tr>
    <th colspan="2" align="center">
@@ -532,7 +520,7 @@ Plugins provide additional content and lets you customize rendered metrics.
  * [🗼 Rss feed <sub>`rss`</sub>](/source/plugins/rss/README.md)
  * [🗨️ Stack Overflow <sub>`stackoverflow`</sub>](/source/plugins/stackoverflow/README.md)
  * [🕹️ Steam <sub>`steam`</sub>](/source/plugins/steam/README.md)
-  * [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md)
+  * [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md) <sub>`⚠️ deprecated`</sub>
  * [⏰ WakaTime <sub>`wakatime`</sub>](/source/plugins/wakatime/README.md)

 **🎲 Maintained by community**
--- a/source/plugins/README.md
+++ b/source/plugins/README.md
@@ -45,7 +45,7 @@ Plugins provide additional content and lets you customize rendered metrics.
  * [🗼 Rss feed <sub>`rss`</sub>](/source/plugins/rss/README.md)
  * [🗨️ Stack Overflow <sub>`stackoverflow`</sub>](/source/plugins/stackoverflow/README.md)
  * [🕹️ Steam <sub>`steam`</sub>](/source/plugins/steam/README.md)
-  * [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md)
+  * [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md) <sub>`⚠️ deprecated`</sub>
  * [⏰ WakaTime <sub>`wakatime`</sub>](/source/plugins/wakatime/README.md)

 **🎲 Maintained by community**
--- a/source/plugins/tweets/README.md
+++ b/source/plugins/tweets/README.md
@@ -3,6 +3,8 @@
  <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr>
  <tr><th colspan="2"><h3>🐤 Latest tweets</h3></th></tr>
  <tr><td colspan="2" align="center"><p>This plugin displays the latest tweets from a <a href="https://twitter.com">Twitter</a> account.</p>
+</td></tr>
+  <tr><th>⚠️ Deprecated</th><td><p>As <a href="https://twitter.com">Twitter</a> removed the ability to fetch tweets from their free API as part of their new <a href="https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api">pricing policy</a>, this plugin is no longer maintained.</p>
 </td></tr>
  <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://twitter.com">Twitter</a>.
 All product and company names are trademarks™ or registered® trademarks of their respective holders.</p>
--- a/source/plugins/tweets/examples.yml
+++ b/source/plugins/tweets/examples.yml
@@ -7,6 +7,10 @@
    plugin_tweets: yes
    plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
    plugin_tweets_user: github
+  prod:
+    skip: true
+  test:
+    skip: true

 - name: Latest tweets including attachments
  uses: lowlighter/metrics@latest
@@ -19,3 +23,7 @@
    plugin_tweets_attachments: yes
    plugin_tweets_user: github
    plugin_tweets_limit: 1
+  prod:
+    skip: true
+  test:
+    skip: true
--- a/source/plugins/tweets/metadata.yml
+++ b/source/plugins/tweets/metadata.yml
@@ -5,6 +5,8 @@ description: |
 disclaimer: |
  This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [Twitter](https://twitter.com).
  All product and company names are trademarks™ or registered® trademarks of their respective holders.
+deprecation: |
+  As [Twitter](https://twitter.com) removed the ability to fetch tweets from their free API as part of their new [pricing policy](https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api), this plugin is no longer maintained.
 examples:
  +latest tweets with attachments: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg
  latest tweets: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg
--- a/tests/cases/tweets.plugin.yml
+++ b/tests/cases/tweets.plugin.yml
@@ -1,20 +1 @@
- name: 🐤 Latest tweets - Latest tweets
-  uses: lowlighter/metrics@latest
-  with:
-    token: NOT_NEEDED
-    plugin_tweets: 'yes'
-    plugin_tweets_token: MOCKED_TOKEN
-    plugin_tweets_user: github
-    use_mocked_data: 'yes'
-    verify: 'yes'
- name: 🐤 Latest tweets - Latest tweets including attachments
-  uses: lowlighter/metrics@latest
-  with:
-    token: NOT_NEEDED
-    plugin_tweets: 'yes'
-    plugin_tweets_token: MOCKED_TOKEN
-    plugin_tweets_attachments: 'yes'
-    plugin_tweets_user: github
-    plugin_tweets_limit: 1
-    use_mocked_data: 'yes'
-    verify: 'yes'
+[]