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

examples folder #92

Closed
7 of 9 tasks
robwise opened this issue Nov 6, 2015 · 5 comments
Closed
7 of 9 tasks

examples folder #92

robwise opened this issue Nov 6, 2015 · 5 comments
Assignees

Comments

@robwise
Copy link
Contributor

robwise commented Nov 6, 2015

The idea is to have a Rakefile script that runs through the generator with differing options, putting each result into an examples folder. We would then implement a hidden dev_tests (or whatever we want to call it) generator that the script makes sure to always pass. A hidden generator is one that is not visible to the public but is nonetheless able to be invoked if you know the command.

This generator will create general sanity tests to ensure various essential functionalities of each result application is working correctly. We could ensure that our CI environment re-generates these results and runs these tests, thereby preventing a scenario where we pull something that breaks the generator apps.

Whether or not we include the examples directory in source control I guess is optional, but I'd be worried that they would sometimes be stale since they would rely on the user making sure to re-generate of their changes.

  • create Rakefile script to generate apps into examples folder
  • ensure that Coveralls, the various linters (actually, we could keep the JS linters), are set up to ignore it
  • create hidden dev_test_generator
  • have generator results script use this option when generating the apps
  • have Rakefile include generated app tests when running test suite
  • move spec/dummy tests to the dev_test_generator and delete dummy apps (optional because this wouldn't work as far as ensuring React v13 compatibility)
  • ensure our CI environment handles all of this appropriately
  • refactor so that we do not unnecessarily rebuild the app, re-run bundle install, or re-run npm install when we don't need to do so
  • incorporate the ability to generate the apps in a separate location and push them to a given GitHub (basically the generator results functionality)
@robwise robwise self-assigned this Nov 6, 2015
@justin808
Copy link
Member

@robwise No need to make it hidden probably. Useful to show what happens.

@justin808
Copy link
Member

@robwise should we close this?

@robwise
Copy link
Contributor Author

robwise commented Nov 17, 2015

@justin808 this has been on hold while I've been working on other things, but it's actually just about ready to go after I make some performance optimizations. Should be really cool! This is what allows us to have CI ensure the generator apps actually work!

@robwise
Copy link
Contributor Author

robwise commented Nov 17, 2015

You can preview the branch here: https://github.com/shakacode/react_on_rails/tree/examples-folder

@robwise
Copy link
Contributor Author

robwise commented Jan 1, 2016

Closing for now

@robwise robwise closed this as completed Jan 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants