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

feat!: remove Transifex calls for OEP-58 | FC-0012 #1198

Merged
merged 1 commit into from
Mar 18, 2024

Conversation

hopewise
Copy link
Contributor

@hopewise hopewise commented Sep 29, 2023

Breaking change!

This change breaks the Jenkins transifex integration which has been deprecated in favor of the new GitHub Transifex App integration as part of OEP-58.

Changes

  • Removes all direct use of tx pull and tx push commands from the micro-frontend in favor
    of the atlas pull command.
  • Remove source and language translations from the repositories, hence no .json files will be committed into the repos.
  • src/i18n/index.js should export and empty array so the make pull_translations override it with the dynamic list of languages.
  • Remove the experimental OPENEDX_ATLAS_PULL flag to make atlas pull the default.
  • Remove all Transifex related Makefile targets and other files.

Test results

  • Verify that make pull_translations works as expected.
make pull_translations test results
# I've run the following commands:
$ make requirements
$ make pull_translations
$ git diff

# Output of the commmands:
make requirements
npm install
npm WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@3. I'll try to do my best with it!

> @edx/[email protected] prepare /Users/sadaftech/Documents/zeit-labs/frontend-app-learning
> husky install

husky - Git hooks installed
npm WARN [email protected] requires a peer of [email protected] - 3 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of popper.js@^1.16.1 but none is installed. You must install peer dependencies yourself.

up to date in 11.654s

276 packages are looking for funding
  run `npm fund` for details

make pull_translations

rm -rf src/i18n/messages
mkdir src/i18n/messages
cd src/i18n/messages \
      && atlas pull \
               translations/paragon/src/i18n/messages:paragon \
               translations/frontend-component-header/src/i18n/messages:frontend-component-header \
               translations/frontend-component-footer/src/i18n/messages:frontend-component-footer \
               translations/frontend-app-learning/src/i18n/messages:frontend-app-learning
Pulling translation files
 - directory: translations/paragon/src/i18n/messages:paragon translations/frontend-component-header/src/i18n/messages:frontend-component-header translations/frontend-component-footer/src/i18n/messages:frontend-component-footer translations/frontend-app-learning/src/i18n/messages:frontend-app-learning
 - repository: openedx/openedx-translations
 - branch: main
 - filter: Not Specified
 - expand-glob: Not Specified
Creating a temporary Git repository to pull translations into "./translations_TEMP"...
Done.
Setting git sparse-checkout rules...
Done.
Pulling translation files from the repository...
remote: Enumerating objects: 11, done.
remote: Counting objects: 100% (11/11), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 11 (delta 5), reused 6 (delta 3), pack-reused 0
Receiving objects: 100% (11/11), 27.62 KiB | 353.00 KiB/s, done.
Resolving deltas: 100% (5/5), done.
Your branch is up to date with 'origin/main'.
Done.
Copying translations from "./translations_TEMP/translations/paragon/src/i18n/messages" to "./paragon"...
Done.
Copying translations from "./translations_TEMP/translations/frontend-component-header/src/i18n/messages" to "./frontend-component-header"...
Done.
Copying translations from "./translations_TEMP/translations/frontend-component-footer/src/i18n/messages" to "./frontend-component-footer"...
Done.
Copying translations from "./translations_TEMP/translations/frontend-app-learning/src/i18n/messages" to "./frontend-app-learning"...
Done.
Removing temporary directory...
Done.

Translations pulled successfully!
./node_modules/.bin/intl-imports.js paragon frontend-component-header frontend-component-footer frontend-app-learning







Merge timeline

This should only be merged after Translation Infrastructure update OEP-58 is fully implemented.

The timing announcement will be shared by @brian-smith-tcril on #translations-project-fc-0012 Open edX Slack channel.

Keep this pull request as a draft to prevent accidental merge.

Pre-merge checklist

References

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

Up-to-date project overview and details are available in the Approach Memo and Technical Discovery: Translations Infrastructure Implementation document.

Join the conversation on Open edX Slack #translations-project-fc-0012.

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

@openedx-webhooks
Copy link

openedx-webhooks commented Sep 29, 2023

Thanks for the pull request, @hopewise! 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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 29, 2023
@OmarIthawi
Copy link
Member

Thanks again @hopewise.

Same comment from the other pull request.

We need to add one more item before we can conclude this PR:

Copy link
Member

@OmarIthawi OmarIthawi left a comment

Choose a reason for hiding this comment

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

Thanks @hopewise!

Confirming that this PR is ready to be merged as soon as openedx/wg-translations#20 is given green light.

@OmarIthawi
Copy link
Member

OmarIthawi commented Oct 9, 2023

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Oct 10, 2023
@itsjeyd
Copy link

itsjeyd commented Oct 10, 2023

Hey @hopewise, thanks for these changes!

It looks like they are part of FC-0012. Would you mind mentioning that in the PR title?

@hopewise hopewise changed the title remove Transifex calls for OEP-58 FC-0012 remove Transifex calls for OEP-58 Oct 10, 2023
@hopewise hopewise changed the title FC-0012 remove Transifex calls for OEP-58 FC-0012 | remove Transifex calls for OEP-58 Oct 10, 2023
@hopewise hopewise changed the title FC-0012 | remove Transifex calls for OEP-58 feat!: remove Transifex calls for OEP-58 | FC-0012 Oct 14, 2023
@itsjeyd itsjeyd added needs test run Author's first PR to this repository, awaiting test authorization from Axim and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Oct 24, 2023
@codecov
Copy link

codecov bot commented Oct 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (92d8f63) to head (f27eb96).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1198   +/-   ##
=======================================
  Coverage   88.40%   88.40%           
=======================================
  Files         291      291           
  Lines        4961     4961           
  Branches     1263     1263           
=======================================
  Hits         4386     4386           
  Misses        561      561           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 24, 2023
@itsjeyd itsjeyd added the blocked by other work PR cannot be finished until other work is complete label Nov 2, 2023
@itsjeyd itsjeyd removed the blocked by other work PR cannot be finished until other work is complete label Feb 23, 2024
@hopewise hopewise marked this pull request as ready for review March 14, 2024 06:53
@OmarIthawi
Copy link
Member

@itsjeyd @timmc-edx @brian-smith-tcril this is ready for merge.

@leangseu-edx leangseu-edx merged commit 94d2083 into openedx:master Mar 18, 2024
7 checks passed
@openedx-webhooks
Copy link

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

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.

7 participants