-
Notifications
You must be signed in to change notification settings - Fork 33
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
feat: convert this library to be "buildless" #498
Conversation
Thanks for the pull request, @bradenmacdonald! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
1c19e8f
to
9506ae0
Compare
9506ae0
to
77c0d1b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
=======================================
Coverage 88.91% 88.91%
=======================================
Files 248 248
Lines 4554 4554
Branches 943 943
=======================================
Hits 4049 4049
Misses 472 472
Partials 33 33 ☔ View full report in Codecov by Sentry. |
@@ -101,6 +101,19 @@ It will also configure the editor to be viewable in the gallery view. Adding the | |||
- To make this easier, we provide example files for `jest.config.js` and `setupTest.js` that are known to work. | |||
You can find them in the example/ folder. | |||
|
|||
## Installing into Course Authoring MFE in dev mode |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a better way to do this?
Closing in favor of openedx/frontend-app-authoring#1208 |
@bradenmacdonald Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
There's no reason to compile this code into a
dist
folder before we publish it. It's only used in the Course Authoring MFE, and that MFE's webpack build has no problem consuming this as raw JSX/TSX files. Publishing an untransformed build has a number of advantages: makes development easier, speeds up CI, simplifies things, and applies consistent babel/polyfill settings to all of the code in the MFE, instead of having separate settings for the editors vs. the rest of the MFE.Part of #499
How to test:
Simple way:
frontend-app-course-authoring
or edit itspackage.json
and change the@edx/frontend-lib-content-components
version to:github:open-craft/frontend-lib-content-components#braden/buildless
npm install
APP_ID=course-authoring PUBLIC_PATH=/course-authoring/ MFE_CONFIG_API_URL='http://localhost:8000/api/mfe_config/v1' npm run start -- --host apps.local.overhang.io
)Advanced way
With this method you can more easily modify the code and get hot reloading as you do:
Concerns
The
www
project doesn't work for me, either before or after this PR. Is it supposed to be working??