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

Create single source of truth for plugin versions #3300

Merged
merged 5 commits into from Oct 7, 2016
Merged

Conversation

mollymerp
Copy link
Contributor

@mollymerp mollymerp commented Oct 5, 2016

Now, whenever a new version of a plugin in https://github.com/mapbox/mapbox-gl-plugins is released, we will only need to update the version in /docs/_data/plugins.json to change the URL version on both the plugins page and the examples page.

cc @ghoshkaj @mcwhittemore @tristen @lucaswoj

Launch Checklist

  • briefly describe the changes in this PR
  • write tests for all new functionality
  • document any changes to public APIs
  • post benchmark scores
  • manually test the debug page

@tristen
Copy link
Member

tristen commented Oct 5, 2016

Awesome stuff!

@lucaswoj
Copy link
Contributor

lucaswoj commented Oct 5, 2016

@mollymerp has graciously agreed to expand the scope of this PR to include #3076 🙌

@mollymerp
Copy link
Contributor Author

Updated to cover #3076 as well -- once this 🚢 we should be able to delete that repo.

Copy link
Contributor

@lucaswoj lucaswoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple 💭 about this. Handle them as you see fit and 🚢

@@ -104,6 +104,8 @@
"start-docs": "npm run build-min && npm run build-docs && jekyll serve --watch",
"lint": "eslint --ignore-path .gitignore js test bench docs/_posts/examples/*.html",
"open-changed-examples": "git diff --name-only mb-pages HEAD -- docs/_posts/examples/*.html | awk '{print \"http://127.0.0.1:4000/mapbox-gl-js/example/\" substr($0,33,length($0)-37)}' | xargs open",
"plugin-test":"tap plugins/test",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep all our tests within test. How about test/plugins?

@@ -104,6 +104,8 @@
"start-docs": "npm run build-min && npm run build-docs && jekyll serve --watch",
"lint": "eslint --ignore-path .gitignore js test bench docs/_posts/examples/*.html",
"open-changed-examples": "git diff --name-only mb-pages HEAD -- docs/_posts/examples/*.html | awk '{print \"http://127.0.0.1:4000/mapbox-gl-js/example/\" substr($0,33,length($0)-37)}' | xargs open",
"plugin-test":"tap plugins/test",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When will these tests get run? If they're quick, we could run them whenever npm test is called.

@@ -8,6 +8,8 @@
- isc
code: https://github.com/mapbox/mapbox-gl-compare
license: ISC
suffix: compare
css: true
js: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may need to go back to the explicit markup if we hever have a 3rd party plugin that:

  • requires extra boilerplate
  • is hosted in a different way
  • uses a different naming convention

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would we want to host 3rd party plugins on the mapbox cdn? I assumed that we would only host plugins that are created in-house but yeah we can always modify the markup in the future.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might. And we might want to document plugins that are hosted other places.

@mollymerp mollymerp merged commit 5994bc3 into master Oct 7, 2016
@mollymerp mollymerp deleted the plugin-data branch October 7, 2016 17:55
@mourner
Copy link
Member

mourner commented Oct 10, 2016

Is it absolutely necessary to include all plugin versions with their assets in the gl-js repository? It doesn't feel quite right to me... Could we e.g. mirror http://unpkg.com/ CDN plugin links instead?

@lucaswoj
Copy link
Contributor

lucaswoj commented Oct 11, 2016

It is not necessary for us to include all plugin versions & assets in the gl-js repository. Doing so was the simplest way to merge the GL JS and GL Plugins repositories. I'd be excited about follow-up issues / PRs that move us towards a more elegant system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants