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

fix: make extract_translations #371

Merged

Conversation

shadinaif
Copy link
Contributor

@shadinaif shadinaif commented May 13, 2023

References

This pull request is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

Check the links above for full information about the overall project.

Internalization is being rearchitected in Open edX Python, XBlock, Micro-frontend, and other projects. There are a number of immediately visible changes:

  • Remove source and language translations from the repositories, hence no .json, .po or .mo files will be committed into the repos.
  • Add standardized make extract_translations in all repositories
  • Push user-facing messages strings into openedx/openedx-translations.
  • Integrate root repositories with openedx/openedx-atlas to pull translations on build/deploy time

Breaking Changes

One of the primary goals of the project is to avoid breaking changes. If you noticed any suspicious code, please raise your concern. But before that, please know the strategy we're following to avoid breaking changes

For XBlocks:

  • The standard translation path must be conf/locale. Therefore, we are creating a link from conf/locale to translations so Atlas can find the path without disrupting the current way of having translations locally within the XBlocks
  • openedx-translations will have a related PR that adds the XBlock to the pipeline. This will not affect the current way of managing/updating translations
  • At the end of the project, a clear change log will be added and all translations will be handled by Atlas. Thus, the local translation will be removed from the repo within the version bump
  • A notification for the community will be published to ensure that everyone knows why translations directories are removed from all repos

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 13, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @shadinaif! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@shadinaif shadinaif mentioned this pull request May 13, 2023
@codecov
Copy link

codecov bot commented May 13, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (98ed45f) 97.75% compared to head (67d1c45) 97.75%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #371   +/-   ##
=======================================
  Coverage   97.75%   97.75%           
=======================================
  Files          77       77           
  Lines        6371     6371           
=======================================
  Hits         6228     6228           
  Misses        143      143           
Flag Coverage Δ
unittests 97.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@shadinaif shadinaif changed the title fix: for make extract_translations fix: make extract_translations May 14, 2023
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch from d344ecc to 4143e5b Compare May 14, 2023 10:43
@brian-smith-tcril brian-smith-tcril added the blocked by other work PR cannot be finished until other work is complete label May 18, 2023
@brian-smith-tcril
Copy link
Contributor

It seems this is following the same pattern as openedx/xblock-drag-and-drop-v2#326

Once the requested changes on that one have been made this should be updated to match the approved pattern. I'm marking this as "blocked by other work" for now

@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch 2 times, most recently from 7df65a1 to 10c174e Compare May 26, 2023 16:39
@shadinaif
Copy link
Contributor Author

Done @brian-smith-tcril

@brian-smith-tcril brian-smith-tcril removed the blocked by other work PR cannot be finished until other work is complete label May 30, 2023
@mphilbrick211
Copy link

Hi @shadinaif @brian-smith-tcril - is this ready for review?

@brian-smith-tcril
Copy link
Contributor

@mphilbrick211 yes it is! According to the spreadsheet a review is required from @MichaelRoytman

Translation directories are not ignored by i18n which make them included in the extraction process

Refs: FC-0012 OEP-58
tail can produce duplicate messages in django.po which will raise an error in compilemessages

Refs: FC-0012 OEP-58
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch from 10c174e to 67d1c45 Compare June 8, 2023 11:55
Copy link
Contributor

@MichaelRoytman MichaelRoytman left a comment

Choose a reason for hiding this comment

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

I apologize for the delay. I was on PTO. Thank you for your patience.

@brian-smith-tcril brian-smith-tcril merged commit cb33ae5 into openedx:master Jun 23, 2023
@openedx-webhooks
Copy link

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

@shadinaif shadinaif deleted the shadinaif/FC-0012-OEP-58.02 branch July 20, 2023 07:59
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
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants