Skip to content

Conversation

@wgu-taylor-payne
Copy link

@wgu-taylor-payne wgu-taylor-payne commented Jun 12, 2025

Description:

The example app configuration has assumed a devstack dev environment, but devstack has been deprecated in favor of using tutor for dev environments. This PR changes things to work with tutor.

Fixes #811.

Merge checklist:

  • Consider running your code modifications in the included example app within frontend-platform. This can be done by running npm start and opening http://localhost:8080.
  • Consider testing your code modifications in another local micro-frontend using local aliases configured via the module.config.js file in frontend-build.
  • Verify your commit title/body conforms to the conventional commits format (e.g., fix, feat) and is appropriate for your code change. Consider whether your code is a breaking change, and modify your commit accordingly.

Post merge:

  • After the build finishes for the merged commit, verify the new release has been pushed to NPM.

@openedx-webhooks
Copy link

Thanks for the pull request, @wgu-taylor-payne!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 12, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 12, 2025
@wgu-taylor-payne wgu-taylor-payne force-pushed the tutor-example-compatibility branch from bd4b3f4 to f00e0fa Compare June 12, 2025 13:34
@codecov
Copy link

codecov bot commented Jun 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.13%. Comparing base (31d2431) to head (242499b).
⚠️ Report is 13 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #819   +/-   ##
=======================================
  Coverage   87.12%   87.13%           
=======================================
  Files          48       48           
  Lines        1406     1407    +1     
  Branches      297      300    +3     
=======================================
+ Hits         1225     1226    +1     
  Misses        168      168           
  Partials       13       13           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jun 16, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 20, 2025
@mphilbrick211
Copy link

Friendly ping on this @brian-smith-tcril @arbrandes

@wgu-taylor-payne
Copy link
Author

I initially added specific steps to the README to overcome the CORS related errors, but I thought it might be better to keep it less prescriptive, so I changed that with my "fixup" commit.

@wgu-taylor-payne
Copy link
Author

@arbrandes @brian-smith-tcril is this worth merging in or, with frontend-base on the horizon, would you rather close this PR?

@mphilbrick211
Copy link

@arbrandes @brian-smith-tcril is this worth merging in or, with frontend-base on the horizon, would you rather close this PR?

@brian-smith-tcril @arbrandes bumping for you :)

@holaontiveros
Copy link

Even with the frontend base on the near future I don't think this is harmful in any way and there's still some time before frontend-base it's out there, so given the work is already done, it looks good to me

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

I think this is a reasonable and desirable change!

I do want to make sure we communicate this out properly. Even with Devstack being deprecated I know it is still being used by some developers. This doesn't require another DEPR, but I want to make sure people that rely on these defaults know they'll need to make changes to their local environments when it lands.

@arbrandes any thoughts on where/how we should communicate this?

@mphilbrick211 mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Sep 11, 2025
@mphilbrick211
Copy link

I think this is a reasonable and desirable change!

I do want to make sure we communicate this out properly. Even with Devstack being deprecated I know it is still being used by some developers. This doesn't require another DEPR, but I want to make sure people that rely on these defaults know they'll need to make changes to their local environments when it lands.

@arbrandes any thoughts on where/how we should communicate this?

Bumping this for you, @arbrandes!

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Approved! Pointed out a typo, though.

@arbrandes
Copy link
Contributor

@brian-smith-tcril,

any thoughts on where/how we should communicate this?

I think we should be fine just merging this. This doesn't affect any actual MFE development workflows, and because local.openedx.io resolves to 127.0.0.1, requests will still hit the right places even if you're using the old devstack. 🤷🏼

@wgu-taylor-payne wgu-taylor-payne force-pushed the tutor-example-compatibility branch from d31a1c6 to 242499b Compare September 23, 2025 15:05
@brian-smith-tcril brian-smith-tcril merged commit acf0d46 into openedx:master Sep 23, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Sep 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Reconfigure example app to work with tutor dev environment

6 participants