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

chore: fix get_default_site function of Enterprise Customer admin page #1798

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

yuanyuan-git-tech
Copy link
Contributor

@yuanyuan-git-tech yuanyuan-git-tech commented Jul 12, 2023

https://2u-internal.atlassian.net/browse/ENT-7322
Screenshot 2023-07-12 at 3 27 04 PM
Screenshot 2023-07-12 at 3 27 14 PM
Screenshot 2023-07-13 at 11 34 24 AM
Screenshot 2023-07-12 at 3 27 33 PM
Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

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 Actions, 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 edx-platform to upgrade dependencies (including edx-enterprise)
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

In production, it should be 'courses.edx.org'.
In stage it should be 'courses.stage.edx.org'.
"""
ENVIRONMENT = os.getenv('DJANGO_ENVIRONMENT', 'development')
Copy link
Contributor

Choose a reason for hiding this comment

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

rather than hard-coding the options here, we should add a configuration setting and/or reuse an existing one such as LMS_BASE

That way is more flexible - it can run in any environment (devstack, hosted devstack, sandboxes, etc) where the domains might vary widely, as well as any opensource community install.

('enterprise', '0176_auto_20230712_1751'),
]

operations = [
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a reason why these changes are in a second migration file?

Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx left a comment

Choose a reason for hiding this comment

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

Looks good! I just have a couple quick comments/questions before we merge. Also don't forget to add your change log and version bumb!

@@ -157,6 +157,18 @@ def get_default_customer_type():
return enterprise_customer_type.id


def get_default_site():
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@@ -223,41 +238,44 @@ class Meta:
)

enable_data_sharing_consent = models.BooleanField(
"Activate data sharing consent prompt",
Copy link
Contributor

Choose a reason for hiding this comment

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

it wasn't clear to me that this param is intended as the verbose_name, could we add the named param to this and the other fields below that include verbose names?

Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx left a comment

Choose a reason for hiding this comment

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

Make sure you add a change log and bump your version before you merge!

@yuanyuan-git-tech yuanyuan-git-tech merged commit 6e3a72f into master Jul 31, 2023
6 checks passed
@yuanyuan-git-tech yuanyuan-git-tech deleted the yuanyuan/ent-7322 branch July 31, 2023 14:51
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