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

OEP for frontend dependency upgrade #513

Closed
wants to merge 5 commits into from

Conversation

abdullahwaheed
Copy link

No description provided.

@feanil
Copy link
Contributor

feanil commented Aug 23, 2023

This is great documentation, I think 2 things need to change:

  1. Make this an ADR on the Frontend Technology Standard OEP(OEP-11) See https://github.com/openedx/open-edx-proposals/tree/master/oeps/best-practices/oep-0011/decisions for examples.

  2. This should cross link to https://docs.openedx.org/en/latest/developers/how-tos/enable-javascript-upgrade-automation.html and that how-to should be updated so that the info there matches the content here. I think the mechanics and sample config can live in the how-to and what we need here is just the decision that we want to automate this and what tool to use.

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.

Thanks for this! This is exactly the kind of decision we should document.

Aside from nit-picking a couple of typos (sorry, I know it's a draft, but can't help myself), I very much like the idea of documenting this. Like Feanil, though, I think this should go in as an ADR to OEP-11. I also support his other suggestions.

oeps/best-practices/oep-0065-bp-frontend-dependencies.rst Outdated Show resolved Hide resolved
oeps/best-practices/oep-0065-bp-frontend-dependencies.rst Outdated Show resolved Hide resolved
oeps/best-practices/oep-0065-bp-frontend-dependencies.rst Outdated Show resolved Hide resolved
oeps/best-practices/oep-0065-bp-frontend-dependencies.rst Outdated Show resolved Hide resolved
oeps/best-practices/oep-0065-bp-frontend-dependencies.rst Outdated Show resolved Hide resolved
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.

I still think that the proposed text in OEP-0066 should live entirely in the renovate ADR.

(The fact that previous OEP-11 ADRs don't contain a lot of text is only because they were moved out from the OEP and there wasn't a lot of detail to port over.)


Context
*******

Openedx mico-frontends(MFEs) use javascript. We maintain these repositoriesusing To upgrade its dependencies through package.json, we can either use `^` or `~` operators to automatically upgrade major and patch versions respectively.
Open edX micro-frontends(MFEs) use javascript. We maintain these repositories using To upgrade its dependencies through package.json, we can either use `^` or `~` operators to automatically upgrade major and patch versions respectively.
Copy link
Contributor

Choose a reason for hiding this comment

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

Using...?

Context
*******

To keep the micro-frontends(MFEs) of Open edX up-to-date, use some tool to autoamte the process.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To keep the micro-frontends(MFEs) of Open edX up-to-date, use some tool to autoamte the process.
To keep the micro-frontends(MFEs) of Open edX up-to-date, use some tool to automate the process.

Context
*******

To keep the micro-frontends(MFEs) of Open edX up-to-date, use some tool to autoamte the process.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To keep the micro-frontends(MFEs) of Open edX up-to-date, use some tool to autoamte the process.
To keep the micro-frontends(MFEs) of the Open edX codebase up-to-date, use some tool to automate the process.

Abstract
********

Proposes best practices for maintaining dependencies on Javascript repositories of Open edX
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Proposes best practices for maintaining dependencies on Javascript repositories of Open edX
Proposes best practices for maintaining dependencies on Javascript repositories of the Open edX codebase.


We can configure renovate bot in our github repositories to update npm packages automatically.

Here are the advantages of using renovate bot:
Copy link
Contributor

Choose a reason for hiding this comment

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

Above you say that this document "Proposes best practices for maintaining dependencies on Javascript repositories", yet this section just explains what options are available. Do we want to actually suggest certain values or value ranges as best practices? For example, should renovate run weekly? Monthly? (I don't know if it's appropriate to suggest values, but wanted to flag it)

@sarina
Copy link
Contributor

sarina commented May 17, 2024

Hi @abdullahwaheed - is there continued energy to keep movement on this OEP?

@abdullahwaheed
Copy link
Author

Hi @abdullahwaheed - is there continued energy to keep movement on this OEP?

Hi @sarina are not following this OEP anymore. I think we can close this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants