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: provide logo url from backend for batch enrollment email #35138

Conversation

mudassir-hafeez
Copy link
Contributor

@mudassir-hafeez mudassir-hafeez commented Jul 18, 2024

Ticket for internal tracking

https://github.com/mitodl/hq/issues/4923

Description

For the past couple of years, edX has supported a logo URL from the backend for Bulk Email and edX ACE emails. But, this does not have similar support for emails using batch enrollment. Not sure if it is intentional or could have some other reasons but it causes the logo URL to be missed if it needs to be passed from the backend similar to Bulk Email and edX ACE emails.

This pull request addresses the logo not appearing in batch enrollment emails when the logo URL is set in the backend and accessed in the template(or custom theme) similar to how edX Bulk or ACE email use.

Useful information to include:

  • No UI changes were made, so no screenshots are necessary.

Supporting information

Testing instructions

  • Ensure that LOGO_URL_PNG_FOR_EMAIL or any of the settings accessed in this code is set.
  • Go to the Membership tab in the Instructor Dashboard with a user having staff access.
  • Send a Batch Enrollment or Batch Beta Tester email.
  • Verify that the logo appears correctly in the email.

Other information

  • This change is isolated to the email template logic and does not depend on other changes.
  • No database migrations are involved.

@openedx-webhooks
Copy link

openedx-webhooks commented Jul 18, 2024

Thanks for the pull request, @mudassir-hafeez!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 18, 2024
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 18, 2024
@mudassir-hafeez mudassir-hafeez force-pushed the mudassir/logo_url_from_backend_for_batch_enrollment branch from dab5082 to e4c62bc Compare July 19, 2024 12:37
@mudassir-hafeez mudassir-hafeez marked this pull request as ready for review July 19, 2024 12:38
@e0d
Copy link
Contributor

e0d commented Jul 24, 2024

Your branch is behind the base. I've pulled in changes from master as a merge commit which will update your branch and cause the tests to be re-run.

@mudassir-hafeez
Copy link
Contributor Author

@e0d, thanks for merging the changes to update my branch and re-run the tests. It seems the commit linting job is failing. I'll fix it and rebase with the upstream master. However, this will require the tests to be re-run.

@mudassir-hafeez mudassir-hafeez force-pushed the mudassir/logo_url_from_backend_for_batch_enrollment branch from ce5bf2a to 15944df Compare July 24, 2024 18:23
@e0d
Copy link
Contributor

e0d commented Jul 24, 2024

@mudassir-hafeez running now.

@mphilbrick211 mphilbrick211 added needs reviewer assigned PR needs to be (re-)assigned a new reviewer and removed needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Jul 24, 2024
@ziafazal ziafazal self-requested a review August 26, 2024 07:13
@mudassir-hafeez mudassir-hafeez force-pushed the mudassir/logo_url_from_backend_for_batch_enrollment branch from 15944df to d517fc8 Compare August 26, 2024 07:54
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

👍

@ziafazal ziafazal merged commit 353dc34 into openedx:master Aug 26, 2024
49 checks passed
@openedx-webhooks
Copy link

@mudassir-hafeez 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@mudassir-hafeez mudassir-hafeez deleted the mudassir/logo_url_from_backend_for_batch_enrollment branch August 26, 2024 11:05
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

mudassir-hafeez added a commit to mudassir-hafeez/edx-platform that referenced this pull request Aug 26, 2024
…edx#35138)

* chore: provide logo url from backend for batch enrollment email
ziafazal pushed a commit that referenced this pull request Aug 27, 2024
…) (#35378)

* chore: provide logo url from backend for batch enrollment email
rediris pushed a commit to gymnasium/edx-platform that referenced this pull request Aug 27, 2024
…edx#35138)

* chore: provide logo url from backend for batch enrollment email
@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Sep 7, 2024
mudassir-hafeez added a commit to mudassir-hafeez/edx-platform that referenced this pull request Sep 13, 2024
…edx#35138)

* chore: provide logo url from backend for batch enrollment email
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants