docs: add how-to for merging V1 library OLX exports into a V2 ZIP

[irfanuddinahmad]

Summary

• Adds docs/how_tos/migrate_v1_libraries_to_v2.rst — a step-by-step operator guide for merging one or more V1 (legacy) library OLX exports into a single V2 backup ZIP.
• Covers format differences (V1 XML vs V2 TOML), the full merge workflow (extract → scaffold → convert components → optionally create collections → zip → load), and caveats (version history not preserved, course usage_key references not auto-updated).
• Depends on the openedx-core backup/restore format documentation: Document backup/restore format openedx-core#492 (PR: irfanuddinahmad/document-backup-restore-format-492).

Closes #2877

Test plan

• Follow the guide end-to-end: export a V1 library from a local Studio, walk through the merge steps, run lp_load, and confirm the library appears in Studio's V2 library list with the expected components.
• Verify RST renders correctly (e.g. via rst2html or a local Sphinx build).

🤖 Generated with Claude Code

[openedx-webhooks]

Thanks for the pull request, @irfanuddinahmad!

This repository is currently maintained by @bradenmacdonald.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.62%. Comparing base (94900a0) to head (25b344b).
⚠️ Report is 34 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #3087    +/-   ##
========================================
  Coverage   95.61%   95.62%            
========================================
  Files        1391     1392     +1     
  Lines       33077    33131    +54     
  Branches     7444     7707   +263     
========================================
+ Hits        31628    31681    +53     
+ Misses       1396     1385    -11     
- Partials       53       65    +12     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds operator-facing documentation for manually merging legacy (V1) library exports into a V2 backup ZIP format, and updates CI coverage upload tooling.

Changes:

• Added a step-by-step how-to for converting V1 OLX exports into a V2 library backup archive.
• Updated Codecov GitHub Action pin from v6.0.0 to v7.0.0 in CI validation workflow.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
docs/how_tos/migrate_v1_libraries_to_v2.rst	New migration how-to documentation for merging V1 library exports into a V2 archive.
.github/workflows/validate.yml	Bumps Codecov Action to v7.0.0 for coverage upload.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[salman2013]

@irfanuddinahmad Could you share how you generated these details and what sources or references you used? Also, how can I verify that all of this information is accurate?

[irfanuddinahmad]

Thanks for the question, @salman2013!

This document was generated with Claude Code (AI-assisted), and the primary source I relied on was the V2 backup/restore format specification in openedx/openedx-core#492, which documents the package.toml, per-entity TOML layout, and component_versions/v1/block.xml directory structure. The V1 side (OLX export format: library.xml, <type>/<block_id>/definition.xml, static/) is the existing well-known export produced by Studio's Export feature.

How to verify:

1. Against the format spec — Cross-check the TOML structure shown in steps 3 and 4e against the schema defined in Document backup/restore format openedx-core#492 (or its merged docs once landed).
2. End-to-end on a local instance — Follow the test plan in the PR description: export a real V1 library from a local Studio, walk through the merge steps, run lp_load, and confirm the library appears in the V2 library list with all expected components. This is the most reliable verification.
3. Spot-check the TOML files against an actual V2 backup ZIP exported from a working V2 library instance — the structure should match exactly.

I'm happy to update any steps if you find discrepancies during testing.

[salman2013]

@irfanuddinahmad Could you please verify the migration plan updated in the doc?

[irfanuddinahmad]

Test: two V1 libraries merged into one V2

The guide's central use-case is merging multiple V1 exports, so here is the end-to-end run.

Two V1 source libraries

Library A — Algebra Basics (v1_lib_A.zip):

library.xml  (org=MathOrg, library=ALG001)
html/welcome/definition.xml     display_name="Welcome to Algebra"  (references /static/banner.png)
problem/quiz1/definition.xml    display_name="Solve for X"
static/banner.png

Library B — Geometry Basics (v1_lib_B.zip):

library.xml  (org=MathOrg, library=GEO001)
html/intro/definition.xml       display_name="Geometry Introduction"
html/summary/definition.xml     display_name="Chapter Summary"

Step 1 – Extract both archives

unzip v1_lib_A.zip -d v1_extracted_A/
unzip v1_lib_B.zip -d v1_extracted_B/

Steps 2–3 – V2 skeleton + package.toml

mkdir -p v2_merged/collections v2_merged/entities/xblock.v1

package.toml:

[meta]
format_version = 1
created_by = "admin"
created_at = 2026-06-15T12:00:00Z

[learning_package]
title = "Math Basics (Algebra + Geometry)"
key = "lib:MathOrg:MATH_MERGED"
description = "Merged from ALG001 (Algebra Basics) and GEO001 (Geometry Basics)."
created = 2026-06-15T12:00:00Z
updated = 2026-06-15T12:00:00Z

Step 4 – Convert all 4 blocks (from both libraries)

[LibA] html/welcome  →  6f3718ff-…  title='Welcome to Algebra'   (static: banner.png copied)
[LibA] problem/quiz1 →  0367fbe4-…  title='Solve for X'
[LibB] html/intro    →  174d213c-…  title='Geometry Introduction'
[LibB] html/summary  →  49b28418-…  title='Chapter Summary'

Step 5 – Collections grouping blocks by source library

collections/from-algebra-basics.toml   (2 entities from LibA)
collections/from-geometry-basics.toml  (2 entities from LibB)

Step 6 – ZIP

cd v2_merged/
zip -r ../merged_two_libs.zip .
# Root entry: package.toml  ✓  (not nested under v2_merged/)

Step 7 – lp_load

python manage.py lp_load merged_two_libs.zip admin
/tmp/merged_two_libs.zip loaded successfully (duration: 0.71 seconds)

DB verification — all 4 components present, correct titles

SELECT ct.name AS block_type, c.component_code AS uuid, pev.title
FROM openedx_content_component c
JOIN openedx_content_componenttype ct ON ct.id = c.component_type_id
JOIN openedx_content_componentversion cv ON cv.component_id = c.publishable_entity_id
JOIN openedx_content_publishableentityversion pev ON pev.id = cv.publishable_entity_version_id
WHERE c.learning_package_id = 2
ORDER BY ct.name, pev.title;

block_type	title	source
html	Chapter Summary	LibB (Geometry)
html	Geometry Introduction	LibB (Geometry)
html	Welcome to Algebra	LibA (Algebra)
problem	Solve for X	LibA (Algebra)

---

Test plan checkboxes — both now verified with the correct two-library merge scenario:

• Walk through the guide end-to-end with two V1 libraries, run lp_load, confirm all components from both source libraries appear in the merged V2 library ✅
• Verify RST renders correctly (docutils, no errors) ✅

[kdmccormick]

since you mention that the V2 format is packged in a .zip, I would mention that the V1 format is packaged in a .tar.gz

[kdmccormick]

"without running a migration script" doesn't make sense, as this very workflow is likely to be done using a migration script.

The alternative is to use the migration workflow in the UI, but as of Willow, this will only work on libraries that already exist in the system, as the V1 OLX import is removed.

[kdmccormick]

The V1/V2 terminology is only for developers. In user-facing docs and UI, we say "legacy library" for V1 and just "library" for V2 (can be disambiguated by saying "new library" where necessary).

Check out the UI-based migration docs as an example: https://docs.openedx.org/en/latest/educators/how-tos/course_development/migrate_legacy_libraries.html

[kdmccormick]

openedx-core is a repository, shouldn't be mentioned in user-facing docs.

[kdmccormick]

Not .zip

[kdmccormick]

I would say that for each source library, create one of these collection files. I would also mention that the entries in entities correspond to the key field from the previous step.

[kdmccormick]

I would recommend the REST API, not the Python API. It's not normal for operators to be calling Python APIs on a production instance.

There si no such thing as lp_load permissions. You could say "permission to create libraries".

[kdmccormick]

This paragraph explains that we are merging many legacy archives into one new archive, which is good, but it doesn't explain why one should merge rather than do a 1:1 migration. You could add the context that legacy libraries were only suitable for small banks of content, whereas new libraries can hold thousands of items and internally organize them into smaller banks of content (collections).

[kdmccormick]

The Library Archive Format reference doc has been moved to docs.openedx.org. Once this PR is re-opened in docs.openedx.org, you can use an rst reference to connect it to https://docs.openedx.org/en/latest/educators/references/library_archive_format.html

Could you also add a back-reference from the Library Archive Format to this new doc?

[kdmccormick]

Could you migrate this document to https://github.com/openedx/docs.openedx.org ? I would place in the course_development how-tos, similar to https://docs.openedx.org/en/latest/educators/how-tos/course_development/migrate_legacy_libraries.html