doc: update document for major release guide

[leangseu-edx]

Description:

Adding PR template for upgrading other package when major release happen.

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.

For Major Release Only

• Update dependency/peer dependency repo to support the breaking change
  • https://github.com/openedx/frontend-component-footer
    • Example: feat: upgrade frontend platform to version 3 frontend-component-footer#241
  • https://github.com/openedx/frontend-component-header
    • Example: feat: upgrade frontend platform to version 3 frontend-component-header#275
  • https://github.com/edx/frontend-component-footer-edx
    • Example: feat: update frontend platform to version 3 edx/frontend-component-footer-edx#208
  • https://github.com/edx/frontend-component-header-edx
    1. update @edx/frontend-enterprise-catalog-search, @edx/frontend-enterprise-logistration, @edx/frontend-enterprise-utils to use the same peer dependency
       • Example: feat: add frontend platform version 3 support to peer dependency frontend-enterprise#278
    2. upgrade the release package to frontend-component-header-edx
       • Example: ....

Post merge:

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

[codecov]

Codecov Report

Base: 81.53% // Head: 81.53% // No change to project coverage 👍

Coverage data is based on head (5574803) compared to base (fb8dee3).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #393   +/-   ##
=======================================
  Coverage   81.53%   81.53%           
=======================================
  Files          38       38           
  Lines         926      926           
  Branches      169      169           
=======================================
  Hits          755      755           
  Misses        159      159           
  Partials       12       12           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[arbrandes]

@leangseu-edx, thanks for this! I like the idea of listing downstream actions on breaking changes.

However, I have mixed feelings about including edx org-specifc checklist items on an openedx PR template: while we certainly don't want to break any downstream repos, to be fair we'd have to keep track of every org's fork. How about if instead a checklist item would say something like "Announce the breaking change in Slack and in the Forum"?

Would like to hear thoughts from @adamstankiewicz and @sarina, here.

[arbrandes]

See inline comment.

[arbrandes]

Had a conversation with the tCRIL team yesterday about this, and our position is this:

While tempting, having upstream (this repo) be responsible for downstream (frontend-component-*) is impractical: upstream can never know how many downstream repos there are, ultimately.

We feel the best solution here is for downstream to subscribe to upstream breaking changes instead. This subscription could be theoretically automated via dependabot/renovate or some other bot, which would make the solution even better than a checklist. What do you think?

To be clear, we think the For Major Release Only should be removed. The "Verify intended release version" item is a good check to keep.

[arbrandes]

This is an example of the automation I mentioned above:

openedx-unsupported/frontend-app-ecommerce#217

[leangseu-edx]

That seems a reasonable approach.