Gatsby: Update Plugin repos that aren't appearing in Plugin library

Created on 13 May 2019  路  16Comments  路  Source: gatsbyjs/gatsby

There are a lot of plugins floating around on repositories that aren't included in the plugin library. Issue #5211 was created to address this, and a lot of progress was made on a script that will find plugins that mention gatsby-source, gatsby-plugin, or gatsby-transformer and don't match the list from Gatsby's keyword search for plugins to include in the library. However, that issue didn't track fixes to repositories that needed to be updated and the script hasn't been completed to post issues in GitHub repositories.

Steps

These packages just need the gatsby and gatsby-plugin keywords included in their package.json (docs for reference). For each plugin:

  1. Find the plugin's source code from npm
  2. Submit a PR (or an issue, maybe they don't want their plugin showing up in the library? 馃し鈥嶁檪 ) that makes sure both gatsby and gatsby-plugin are included in the keywords section of the package.json
  3. Mark that plugin as done in this issue

Plugins to Update

Running the script lists these packages from npm that should be updated:

(Check marks are added when an issue or PR has been created, they are crossed out when keywords have been merged)

(_Update_: all repos have had an issue or PR filed, thanks everyone!)

If someone is feeling ambitious, development of the script discussed in #5211 could be continued in that issue for the future when more plugins leave off these keywords, but it'd be helpful to simply make a PR to existing repositories from the list above including the keywords and get these plugins included in the library.

Once a plugin has had keywords merged into it's repo, feel free to edit this issue to check it off the list 馃檪

good first issue help wanted
Source
picture gillkyle
👍7

Most helpful comment

Hi! I've just made my first open source pull request in gatsby-plugin-graphql. I will try to hunt another plugins as soon as I get home.

picture dmarkiewicz on 14 May 2019
🎉4 🚀2

All 16 comments

Awesome @gillkyle, you're the best!

wardpeet picture wardpeet on 13 May 2019

Related to https://github.com/gatsbyjs/gatsby/issues/12503

marcysutton picture marcysutton on 13 May 2019

Hi! Here are the plugins I have made PRs to (they include some that already included the keywords).

  • [X] gatsby-plugin-escalade-stock
  • [X] gatsby-plugin-product-markdown-pages
  • [x] gatsby-plugin-source-john-deere
  • [x] gatsby-plugin-production
  • [x] gatsby-source-product-markdown
  • [x] gatsby-plugin-purify-css
  • [x] gatsby-plugin-stripe-elements
  • [x] gatsby-plugin-indieweb
  • [x] gatsby-plugin-i18n-extension
  • [x] gatsby-plugin-favicons
  • [x] gatsby-source-jsonapi
  • [x] gatsby-source-twitter-users
  • [x] gatsby-source-medium-posts
  • [x] gatsby-source-itchio
  • [x] gatsby-transformer-geojson
  • [x] gatsby-source-gdrive-tree
  • [x] gatsby-plugin-polyfill-cdn
  • [x] gatsby-plugin-channel
  • [ ] gatsby-source-stripe-products (archived repo)
  • [x] gatsby-transformer-exif
  • [x] gatsby-plugin-snowplow
ashley picture ashley on 14 May 2019
🎉4 🚀2

Hi! I've just made my first open source pull request in gatsby-plugin-graphql. I will try to hunt another plugins as soon as I get home.

dmarkiewicz picture dmarkiewicz on 14 May 2019
🎉4 🚀2

we probably want to update our script somehow to check if a repo is archived or not. If anyone wants to update https://github.com/gatsbyjs/gatsby/blob/master/scripts/gatsby-plugin-checker/index.js we would be grateful.

wardpeet picture wardpeet on 14 May 2019

I would like to take care of it. Should I just create a pull request or are there any other steps I need to take?

dmarkiewicz picture dmarkiewicz on 14 May 2019

Thanks for the help @ashley and @dmarkiewicz!

@dmarkiewicz I would reference the guidelines mentioned in Issue 5211 as well, but then making a pull request that at least checks if the repo is archived like @wardpeet mentioned would be fantastic 馃檪

gillkyle picture gillkyle on 14 May 2019
👍1

@gillkyle I think that checking if repositories are archived require a Github App Token because there is a limit of 60 requests per hour. To check if repository is archived I need to call API for each of them and that might exceed the limit. Is there a possibility to create such token?

I think it might be also necessary for creating comments in those repositories.

dmarkiewicz picture dmarkiewicz on 14 May 2019

Issues created:

  • [x] [gatsby-source-twitch](https://www.npmjs.com/package/gatsby-source-twitch)
  • [x] [gatsby-source-soundcloud](https://www.npmjs.com/package/gatsby-source-soundcloud)
  • [x] [gatsby-source-steam](https://www.npmjs.com/package/gatsby-source-steam)

PRs created:

  • [ ] [gatsby-source-google-calendar](https://www.npmjs.com/package/gatsby-source-google-calendar)
  • [x] [gatsby-source-google-sheet](https://www.npmjs.com/package/gatsby-source-google-sheet)
  • [x] [gatsby-source-github-api](https://www.npmjs.com/package/gatsby-source-github-api)
  • [ ] [gatsby-plugin-github-pages](https://www.npmjs.com/package/gatsby-plugin-github-pages)
  • [ ] [gatsby-plugin-react-webfont-loader](https://www.npmjs.com/package/gatsby-plugin-react-webfont-loader) - MR open on GitLab
  • [ ] [gatsby-source-utopian](https://www.npmjs.com/package/gatsby-source-utopian)

Repo archived:

  • [ ] [gatsby-source-github-projects](https://www.npmjs.com/package/gatsby-source-github-projects) [[repo](https://github.com/CityOfBoston/gatsby-source-github-projects#readme)]

Misc:

  • [ ] [gatsby-plugin-netlify-lambda](https://www.npmjs.com/package/gatsby-plugin-netlify-lambda)
    I had to use the contact form of MerchantLabs.io as the repository listed for this plugin returns a 404 (https://github.com/merchantlabs/gatsby-plugin-netlify-lambda).
    Screenshot 2019-05-14 at 22 17 44
RobinCsl picture RobinCsl on 14 May 2019
🚀2 🎉1

Thanks for adding your help on so many of these @RobinCsl!

I guess that Netlify lambda plugin must be in a private repo or something. If that's the case they may not want to include it as a plugin in the library but good we've at least made them aware how they can!

gillkyle picture gillkyle on 14 May 2019
👍1

I've opened some PRs for now:

  • [x] [gatsby-transformer-nimbl](https://github.com/NimblNotes/gatsby-transformer-nimbl/pull/2)
  • [ ] [gatsby-plugin-core-js](https://github.com/lloydh/gatsby-plugin-core-js/pull/1)
  • [ ] [gatsby-transformer-ipynb](https://github.com/n6g7/gatsby-transformer-ipynb/pull/5)
  • [x] [gatsby-plugin-ngrok-tunneling](https://github.com/stevenkaspar/gatsby-plugin-ngrok-tunneling/pull/4)
  • [ ] [gatsby-source-sapcc](https://github.com/KyleRichardson-TB/gatsby-source-sapcc/pull/1)
  • [x] [~gatsby-source-published-google-sheets~](https://github.com/nathunsmitty/gatsby-source-published-google-sheets/blob/master/package.json)
  • [x] [~gatsby-plugin-protoculture~](https://github.com/atrauzzi/gatsby-plugin-protoculture/blob/master/package.json)

The above already have gatsby-plugin

  • [ ] [gatsby-source-wordpress-bcgdv](https://www.npmjs.com/package/gatsby-source-wordpress-bcgdv) is a security holding package
poyea picture poyea on 15 May 2019
🎉1

PRs Created:

  • [ ] gatsby-source-newsapi
  • [ ] gatsby-source-nba
  • [ ] gatsby-source-gcloud-object
  • [ ] gatsby-plugin-sass-bulk-import
  • [ ] gatsby-plugin-mui
  • [ ] gatsby-plugin-drip
  • [ ] gatsby-plugin-iamport
  • [ ] gatsby-plugin-module-local-ident-name
  • [ ] gatsby-plugin-copy-files
  • [ ] matthewsommer/gatsby-source-jira
  • [ ] gatsby-plugin-size-analyzer
  • [ ] gatsby-source-mongo
  • [ ] gatsby-transformer-whoa

Following has gatsby and gatsby-plugin included in keywords already

  • [ ] gatsby-plugin-favicon-mperkh
  • [ ] gatsby-source-airtable
PriyaBhatt13 picture PriyaBhatt13 on 15 May 2019
🎉3

@dmarkiewicz let's just not do it then, api tokens are to much hassle when running it. Another way would be to do a get request to the repo and search for the string but that's just to messy so we'll just deal with it 馃槑

Thanks for looking into it!

wardpeet picture wardpeet on 15 May 2019

Thanks for finishing up the last packages @PriyaBhatt13!

We've now got PRs and issues filed in all the repos listed, thanks for all the help 馃 I'll be monitoring the issues here to watch as things (hopefully) get merged in.

gillkyle picture gillkyle on 15 May 2019

I sent emails to the package authors that haven't been updated yet, encouraging them to merge PR's, several have responded already.

gillkyle picture gillkyle on 21 May 2019
❤2 👍1

Closing as we've done what we can on our end, many of the remaining plugins aren't being maintained or updated and pull requests have been made that package maintainers have the option of merging.

According to the initial list 37 plugins were added to the plugin library so thanks everyone! 馃憦

gillkyle picture gillkyle on 3 Jun 2019
Was this page helpful?
0 / 5 - 0 ratings

Related issues

jimfilippou picture jimfilippou  路  3Comments
ghost picture ghost  路  3Comments
ferMartz picture ferMartz  路  3Comments
3CordGuy picture 3CordGuy  路  3Comments
dustinhorton picture dustinhorton  路  3Comments