feat: update 2u/main branch with new readme/docs and create first 2u/main version

[christopappas]

⛔️ MAIN BRANCH WARNING! 2U EMPLOYEES must make branches against the 2u/main BRANCH

• I have checked the branch to which I would like to merge.

⛔️ 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]

If you're merging to master (not 2u/main) branch...

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

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

You are expected to release and monitor your changes (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.

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
  • Warning: You must use 2u/main as the target release branch
  • Note: You should prefix the tag with "2u/" (for example, "2u/3.3.4")
  • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
• PR created in ecommerce against 2u/main branch to upgrade dependencies (including ecommerce-worker)
  • Note: the ecommerce-worker constraint in ecommerce must also be bumped to the tag version you just released.
• 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.

[julianajlk]

There was an example on the other PR on the pull request template to add the 2U prefix to the version number, can you modify that - if we're not supposed to add the prefix?

https://github.com/openedx/ecommerce-worker/blob/a1af7a158d5cb655b06747f9b2a7b3f4a55c85cb/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L46

[christopappas]

There was an example on the other PR on the pull request template to add the 2U prefix to the version number, can you modify that - if we're not supposed to add the prefix?

https://github.com/openedx/ecommerce-worker/blob/a1af7a158d5cb655b06747f9b2a7b3f4a55c85cb/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L46

chatted, and confirmed the prefix is intended for the tag release, but just not the version that's present in __init__.py