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

Allow @openedx-namespaced NPM packages to be built #806

Closed
Tracked by #23
arbrandes opened this issue Jun 23, 2023 · 5 comments
Closed
Tracked by #23

Allow @openedx-namespaced NPM packages to be built #806

arbrandes opened this issue Jun 23, 2023 · 5 comments
Assignees
Labels
maintenance Routine upkeep necessary for the health of the platform

Comments

@arbrandes
Copy link
Contributor

Description

As a first step in the direction of renaming all relevant @edx NPM packages to @openedx, allow new NPM packages in the org to be built in the @openedx namespace.

We should also take the opportunity to start investigating how to make the future renaming process more palatable (such as by using some form of aliasing).

Further info

@arbrandes arbrandes added the maintenance Routine upkeep necessary for the health of the platform label Jun 23, 2023
@feanil
Copy link
Contributor

feanil commented Jul 19, 2023

@arbrandes do you have a package in mind that we can start publishing to the new org today? Are there defaults we need to change somewhere in our templates?

@arbrandes
Copy link
Contributor Author

I'm not aware of an openedx cookiecutter or template for JS libraries, so I don't think we have to worry about a default. I just checked for related developer documentation, but couldn't find any, either.

That said, it wouldn't hurt to open a PR to frontend-template-application that changes the namespace accordingly, even if it doesn't get published anywhere. 🤷🏼‍♂️

As for a package we could rename today, I think the recently-added react-unit-test-utils would be the best candidate. Not sure if it's even used by any MFEs, yet. We'll just have to coordinate with @muselesscreator. (Hey Ben! 😉 )

@feanil
Copy link
Contributor

feanil commented Oct 17, 2023

I'm gonna try this with the https://github.com/openedx/brand-openedx package to figure out the details since that package is presumably fully under our purview and probably touches many other packages.

@feanil
Copy link
Contributor

feanil commented Oct 18, 2023

Copying from the main ticket to keep track of here.

  • Do a final publish of the package into the edx org if the latest code hasn't already been published.
  • Update the code to scope the package to the openedx NPM org.
  • Publish to the openedx org at the same version as in the edx org.
    • Outstanding Question: Will Semantic release let us do that? Might need to do a minor version bump.
      • It's annoying to re-publish the same version so we just do a minor version bump.
  • Update all projects in the openedx org that use this package to use the new openedx scoped one.
  • Notify community of the change and newly available package so they can update any code they have.

@feanil
Copy link
Contributor

feanil commented Oct 30, 2023

The announcement was made over here: https://discuss.openedx.org/t/npm-scope-change-for-open-edx-packages/11481

We can now easily build and publish to the openedx NPM scope from the openedx org. The npm-publish workflow template has the correct settings to use.

@feanil feanil closed this as completed Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Routine upkeep necessary for the health of the platform
Projects
Status: Done
Status: Closed
Development

No branches or pull requests

2 participants