Skip to content

Comments

feat: support added to export content libraries to git#38026

Open
marslanabdulrauf wants to merge 1 commit intoopenedx:masterfrom
mitodl:marslan/10083-export-content-libraries-git
Open

feat: support added to export content libraries to git#38026
marslanabdulrauf wants to merge 1 commit intoopenedx:masterfrom
mitodl:marslan/10083-export-content-libraries-git

Conversation

@marslanabdulrauf
Copy link
Contributor

@marslanabdulrauf marslanabdulrauf commented Feb 19, 2026

Ticket

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

Description

This pull request enhances the export_to_git workflow to support exporting both course and library content, including v2 libraries, to a git repository. It introduces a new export mechanism for v2 libraries using a zip-based backup API, refactors the main export function for broader content support, and improves logging and commit messages for clarity.

Support for v2 library export and generalization of export logic:

  • Added a new export_library_v2_to_zip function to export v2 libraries using the backup API, creating a zip backup and extracting it to the target directory.
  • Refactored export_to_git to accept a general content_key (course or library), automatically detect the content type, and select the appropriate export function for courses, v1 libraries, or v2 libraries. [1] [2]

Improvements to commit messages and logging:

  • Updated the git commit message to include the content type (course or library) and timestamp for better traceability.
  • Enhanced logging to provide clearer information on successful exports, including the content type and key.

Dependency and import updates:

  • Added imports for modules required by the new export and backup logic, including shutil, zipfile, datetime, Path, mkdtemp, slugify, and LibraryLocatorV2.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

  1. Call this export_to_git function with different content_keys to test if they are exported properly to Github.
  2. Make sure you have proper access rights for the repo

I have been testing it with ol-openedx-git-auto-export -- This Library export feature is not released yet

@openedx-webhooks
Copy link

Thanks for the pull request, @marslanabdulrauf!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants