Skip to content

feat: add script to update from main#51471

Open
igobranco wants to merge 1 commit intoopenedx:mainfrom
fccn:igobranco/add-update-from-main
Open

feat: add script to update from main#51471
igobranco wants to merge 1 commit intoopenedx:mainfrom
fccn:igobranco/add-update-from-main

Conversation

@igobranco
Copy link
Copy Markdown

Add a script to make it more easy to update the current translations with the fixes and new translations from the upstream main.

This PR adds a Python script that updates the current translations from the upstream main translations.
So from a previous release we can make it more easy just receive the latest patched (fixed) and/or new translations.

Use cases:

  1. Some translations is 'fixed' on transifex and with this script we can update the open release branch with the latest translations.
  2. Instead of having to fix both release and head translations to operator can just receive the new translations.

Copied from the script comment:

Update release branch translations with fixes and new strings from the main branch.

This script synchronizes translation files between a release branch and an upstream branch
(typically 'main'). It supports both JSON and PO (gettext) translation files.

Key features:
- Fetches upstream translations from a git branch (no local clone needed)
- Merges translations preferring upstream fixes over local versions
- Adds new translation strings from upstream that don't exist locally
- Preserves PO file formatting using msgcat with --no-wrap
- Supports filtering by language code and file type

For JSON files:
- Parses both local and upstream JSON files
- Adds new translation keys from upstream
- Preserves existing local translations for unchanged keys
- Sorts keys alphabetically for consistency

For PO files:
- Uses msgcat with --use-first to prefer upstream msgstr values (fixes)
- Uses --no-wrap to preserve original line formatting
- Uses --sort-output for consistent entry ordering
- Maintains proper gettext format and metadata

Usage:
    python update_from_main.py [OPTIONS]

Examples:
    # Update all languages and file types from main branch
    python update_from_main.py --branch main
    
    # Update only Portuguese translations
    python update_from_main.py --language pt_PT
    
    # Update only PO files for multiple languages
    python update_from_main.py --language pt_PT --language es_419 --file-type po
    
    # Dry run to preview changes
    python update_from_main.py --dry-run
    
    # Update from a different upstream repository
    python update_from_main.py --branch nau/redwood.master --upstream-repo https://github.com/openedx/openedx-translations.git

Add a script to make it more easy to update the current translations with the fixes from the upstream main.
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Dec 10, 2025
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @igobranco!

This repository is currently maintained by @openedx/committers-translations.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

Details
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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Dec 10, 2025
@igobranco igobranco requested a review from OmarIthawi December 10, 2025 22:52
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Dec 11, 2025
@mphilbrick211 mphilbrick211 requested a review from a team February 25, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

3 participants