Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Plugin repos that aren't appearing in Plugin library #14013

Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with.

Comments

@gillkyle
Copy link
Contributor

gillkyle commented May 13, 2019

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 🙂

@gillkyle gillkyle added help wanted Issue with a clear description that the community can help with. good first issue Issue that doesn't require previous experience with Gatsby 🎯Ecosystem labels May 13, 2019
@wardpeet
Copy link
Contributor

Awesome @gillkyle, you're the best!

@marcysutton
Copy link
Contributor

Related to #12503

@ashley
Copy link

ashley commented May 14, 2019

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

  • gatsby-plugin-escalade-stock
  • gatsby-plugin-product-markdown-pages
  • gatsby-plugin-source-john-deere
  • gatsby-plugin-production
  • gatsby-source-product-markdown
  • gatsby-plugin-purify-css
  • gatsby-plugin-stripe-elements
  • gatsby-plugin-indieweb
  • gatsby-plugin-i18n-extension
  • gatsby-plugin-favicons
  • gatsby-source-jsonapi
  • gatsby-source-twitter-users
  • gatsby-source-medium-posts
  • gatsby-source-itchio
  • gatsby-transformer-geojson
  • gatsby-source-gdrive-tree
  • gatsby-plugin-polyfill-cdn
  • gatsby-plugin-channel
  • gatsby-source-stripe-products (archived repo)
  • gatsby-transformer-exif
  • gatsby-plugin-snowplow

@dmarkiewicz
Copy link
Contributor

dmarkiewicz commented May 14, 2019

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.

@wardpeet
Copy link
Contributor

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.

@dmarkiewicz
Copy link
Contributor

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?

@gillkyle
Copy link
Contributor Author

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 🙂

@dmarkiewicz
Copy link
Contributor

dmarkiewicz commented May 14, 2019

@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.

RobinCsl added a commit to RobinCsl/gatsby-source-google-calendar that referenced this issue May 14, 2019
Hello 👋 

As part of gatsbyjs/gatsby#14013, I would like to add `gatsby` and `gatsby-plugin` keywords to the `package.json` file of your source plugin.

It is documented in https://www.gatsbyjs.org/contributing/submit-to-plugin-library/ if you would like to know more about it.

If you accept to merge this PR, could you also publish a patch version of your source plugin on NPM? 

Thank you very much!
@RobinCsl
Copy link
Contributor

RobinCsl commented May 14, 2019

Issues created:

PRs created:

Repo archived:

Misc:

Screenshot 2019-05-14 at 22 17 44

@gillkyle
Copy link
Contributor Author

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!

@poyea
Copy link
Contributor

poyea commented May 14, 2019

I've opened some PRs for now:


The above already have gatsby-plugin

@PriyaBhatt13
Copy link

PriyaBhatt13 commented May 15, 2019

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

@wardpeet
Copy link
Contributor

@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!

@gillkyle
Copy link
Contributor Author

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
Copy link
Contributor Author

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

aendra-rininsland pushed a commit to aendra-rininsland/gatsby-source-google-sheet that referenced this issue May 28, 2019
Hello 👋

As part of gatsbyjs/gatsby#14013, I would like to add gatsby and gatsby-plugin keywords to the package.json file of your source plugin.

It is documented in https://www.gatsbyjs.org/contributing/submit-to-plugin-library/ if you would like to know more about it.

If you accept to merge this PR, could you also publish a patch version of your source plugin on NPM? Let me know if I can assist in any way with this. 🙂

Thank you very much!
@gillkyle
Copy link
Contributor Author

gillkyle commented Jun 3, 2019

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 gillkyle closed this as completed Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment