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

Migrate fixtures to new capability syntax #478

Closed
FloEdelmann opened this issue Apr 13, 2018 · 1 comment
Closed

Migrate fixtures to new capability syntax #478

FloEdelmann opened this issue Apr 13, 2018 · 1 comment
Labels
component-fixture Affects one or more existing fixture definitions. help wanted More information/insights or implementation wanted from others. priority-high Implementing this would improve OFL a considerate amount.

Comments

@FloEdelmann
Copy link
Member

FloEdelmann commented Apr 13, 2018

In PR #425 (new-capabilities branch), we have updated our schema to better represent the real world effect of capabilities (see also #267).

We have already migrated some fixtures, but not all. If you want to help, follow these steps:

  1. Fork this repository, clone your fork to a local directory.
  2. Switch to new-capabilities branch: git checkout new-capabilities
  3. Update dereferenced schemas: make -B
  4. Run ./tests/fixtures-valid.js.
  5. Choose a fixture you want to migrate, and run ./cli/fixture-migration-helper.js -f fixtures/<manufacturer key>/<fixture key>.json in the project root folder. The script does a lot of the work for you!
  6. Migrate the fixture definition (if you use an editor like VS Code, it'll provide you with inline suggestions and error checks). You might want to have the new capability types documentation open.
  7. Change $schema back to its original value.
  8. Run ./tests/fixtures-valid.js again. It should now pass for your fixture.
  9. When you're done, commit and push your changes.
  10. Open a new pull request against the new-capabilities branch: https://github.com/OpenLightingProject/open-fixture-library/compare/new-capabilities...YOUR_GITHUB_USERNAME:new-capabilities
@FloEdelmann FloEdelmann added component-fixture Affects one or more existing fixture definitions. help wanted More information/insights or implementation wanted from others. priority-high Implementing this would improve OFL a considerate amount. labels Apr 13, 2018
@fxedel fxedel mentioned this issue May 11, 2018
56 tasks
@FloEdelmann
Copy link
Member Author

Closing this since all fixtures are migrated and new ones need individual work anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component-fixture Affects one or more existing fixture definitions. help wanted More information/insights or implementation wanted from others. priority-high Implementing this would improve OFL a considerate amount.
Projects
None yet
Development

No branches or pull requests

1 participant