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

feat: adds a rudimentary shell that works for dev environments #22

Merged
merged 13 commits into from
Jul 31, 2024

Conversation

davidjoy
Copy link
Contributor

This is a point-in-time PR. It adds a rudimentary shell application and cleans up references to frontend-platform.

The shell application has been tested by the use-shell branch of davidjoy/frontend-app-base-test: https://github.com/davidjoy/frontend-app-base-test/tree/djoy/use-shell

If you check out frontend-base and the use-shell branch of frontend-app-base-test as peer folders, you can add this script to frontend-base to install it as a local dependency of frontend-app-base-test:

"scripts": {
...
+   "pack:base-test": "npm run build && npm pack && cd ../frontend-app-base-test && npm i ../frontend-base/openedx-frontend-base-1.0.0.tgz && cd ../frontend-base",
...
},
...

In frontend-base, run:

npm run pack:base-test

And in frontend-app-base-test, run:

npm run dev:shell

On port 8082 you'll see an MFE that uses the shell from frontend-base to wrap modules from frontend-app-base-test.

davidjoy and others added 11 commits July 24, 2024 15:31
We still needed to update the shell’s header code to use the runtime directory instead of frontend-platform.  This adjusts those imports.

Also adding missing dependencies.
Most of these references are in comments and documentation.  Touching the files has also rearranged their imports alphabetically.
This commit also adds a first draft of the steps necessary to convert an MFE to use the shell.  Not everything described in those steps actually exists yet.

The CLI commands may change, as well, along with the guts of the new webpack.shell.dev.config.js configuration.
We still have two repositories to merge into frontend-base: frontend-component-footer and frontend-plugin-framework.  If Renovate pushes commits to main while we're trying to pull in hundreds of commits from those repositories, it makes rebasing on top of renovate's commits nearly impossible.

For now, let's just turn off auto-merging of renovate commits until we get these repos in.
Should satisfy the linter.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 31, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @davidjoy!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

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.

LGTM!

davidjoy added 2 commits July 31, 2024 13:16
At least I think this exports it properly; seems to work in apps!
Just tryin to get the test suite to pass here!
@davidjoy davidjoy merged commit b370362 into openedx:main Jul 31, 2024
5 checks passed
@openedx-webhooks
Copy link

@davidjoy 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants