Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

feat: splitting master and 2u/main branches #226

Merged
merged 11 commits into from
Dec 6, 2023

Conversation

christopappas
Copy link
Contributor

⛔️ DEPRECATION WARNING

This repository is deprecated and in maintainence-only operation while we work on a replacement, please see this announcement for more information.

Although we have stopped integrating new contributions, we always appreciate security disclosures and patches sent to [email protected]

Anyone internally merging to this repository is expected to release and monitor their changes; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production
    • test.in for test requirements
    • make upgrade && make requirements have been run to regenerate requirements
  • Version bumped

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub CI, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in ecommerce to upgrade dependencies (including ecommerce-worker)
    • This must be done after the version is visible in PyPi as make upgrade in ecommerce will look for the latest version in PyPi.
    • Note: the ecommerce-worker constraint in ecommerce must also be bumped to the latest version in PyPi.
  • Deploy ecommerce
  • Deploy ecomworker on GoCD.
    • While some functions in ecommerce-worker are run via ecommerce, others are handled by a standalone AMI and must be
      released via GoCD.

@christopappas christopappas requested a review from a team as a code owner December 6, 2023 15:02
@@ -6,6 +10,8 @@ Although we have stopped integrating new contributions, we always appreciate sec

## Anyone internally merging to this repository is expected to [release and monitor their changes](https://openedx.atlassian.net/wiki/spaces/RS/pages/1835106870/How+to+contribute+to+our+repositories); if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Internally" is an ambiguous word here. I'm not sure if it pre-dated your work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updating in next commit. please hold...

README.rst Outdated
@@ -68,9 +68,11 @@ The code in this repository is licensed under the AGPL unless otherwise noted. P
How To Contribute
-----------------

Anyone merging to this repository is expected to `release and monitor their changes <https://openedx.atlassian.net/wiki/spaces/RS/pages/1835106870/How+to+contribute+to+our+repositories>`__; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.
Notice: Internal 2U contributions should be made against the ``2u/main`` branch. Open source contributions should continue to be made against the ``master`` branch.
Copy link
Contributor

Choose a reason for hiding this comment

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

"changes"

Context
-------

Both 2U and the Open edX community use ecommerce-worker's master branch for releases. Occasionally, changes
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought I had suggested a change in the ecommerce ADR to put this sentence in the past tense, to make the new current state clearer. But I see it's the same in the ecommerce repo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yikes i might have missed that. i have to make a PR to ecommerce as part of this work, so i can update the ADR there too

Copy link
Contributor

@nedbat nedbat left a comment

Choose a reason for hiding this comment

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

Two small changes.


## If you're merging to 2u/main branch...

You are expected to `release and monitor your changes <https://2u-internal.atlassian.net/wiki/spaces/RS/pages/7963261/How+to+contribute+to+our+repositories>`__ (2U-private link); if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.

Choose a reason for hiding this comment

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

This is supposed to be formatted as code and not a link?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed! i was using rst markup

@christopappas christopappas merged commit 149a423 into master Dec 6, 2023
6 checks passed
@christopappas christopappas deleted the cpappas/update-2u-main-split branch December 6, 2023 19:51
christopappas added a commit that referenced this pull request Dec 6, 2023
* feat: splitting master and 2u/main branches (#226)

* docs: update PR template

* docs: add ADR

* feat: remove pypi publish workflow for 2u/main

* feat: update 2u/main branch readme docs
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants