Skip to content

Left over items in 'xblocks-extra` consolidation #16

Closed
Closed
Left over items in 'xblocks-extra` consolidation#16
Assignees
feanilfarhan

Description

@farhan
farhan
opened on Apr 7, 2026

Dropping points pop up into my mind while reviewing the PR's so we don't miss them.

  1. License should be created/moved at the root
  2. License should be bundled in the packaging
  3. How the python upgrade will work
  4. How the common constraints for edx repos will be applied -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
  5. catalog-info.yaml should be created at the root
  6. Are we going to move openedx.yaml For example
  7. PACKAGE DATA should be revised for all the xblocks as we are not shifting the packaging strategies for example
  8. i18n should be supported, translations commands in make file is pending to add
  9. Testing of docs is pending
  10. Make sure all the readme content of the xblocks has been moved to the xblocks-extra repository. We should create different read-me files for different blocks in their directories for isolation and easy maintenance.
  11. We should reference the inter block readmes to the main readme file and list the xblocks repo will contain.
  12. We should also make sure all the migrated XBlocks have been marked deprecated and archived before closing this epic.
  13. What about the issues created in the main repositories, should we move them all, I think so.
  14. What about the un-merged PR's, I think as soon as we make xblocks-extra ready, publish it on pypi, we can drop message on the PR's to shift their PR's.
  15. Adding @kdmccormick comment on xblocks-extra:
We should make sure:

Existing sites will be able to uninstall the old packages and install xblocks-extra seamlessly.
There will be documentation explaining that to them.
Both the old repos and xblocks-extra work in Verawood, so that they have a full release to transition.
  1. Write transition/migration notes for the Verawood open edx release
  2. Update xblocks-extra readme to add a transition section [doc for the community; how to shift to xblocks-extra]
  3. Add the archiving xblocks [that are not merged] to the verawood release notes as well.

Activity

  1. farhan
    added this to Aximprovements Teamon Apr 7, 2026
  2. farhan
    added a parent issue on Apr 7, 2026
  3. farhan
    moved this to 📋 Backlog in Aximprovements Teamon Apr 7, 2026
  4. FuaadZam
    assigned
    farhan
    and
    feanil
    on Apr 8, 2026

  5. feanil commented on Apr 10, 2026

    @feanil
    feanil
    on Apr 10, 2026
    Contributor
    1. License should be created/moved at the root

    Agreed, this should be AGPL-3

    2. License should be bundled in the packaging

    Agreed

    3. How the python upgrade will work

    We need to add make upgrade targets that will use uv to keep dependencies in sync and locked. See openedx/xqueue-watcher#122 for an example of how to do this.

    4. How the common constraints for edx repos will be applied `-c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt`

    I think we'll be continuing to move away from that so let's try to keep it out of this repo for now and see if that causes any issues.

    5. `catalog-info.yaml` should be created at the root

    Yes, the owner should be axim-engineering for this.

    6. Are we going to move `openedx.yaml` For [example](https://github.com/openedx/xblock-qualtrics-survey/blob/master/openedx.yaml)

    No, openedx.yaml is no longer used and should be removed so no need to be ported to this new repo.

    7. `PACKAGE DATA` should be revised for all the xblocks as we are not shifting the packaging strategies for [example](https://github.com/openedx/FeedbackXBlock/blob/master/MANIFEST.in)

    You'll have to port this info into the pyproject.toml format but it should translate pretty easily.

    8. i18n should be supported, translations commands in `make` file is pending to add

    Agreed, we should add these as we move over packages that provide translations. We'll also need to add this repo to the openedx-translations repo so that translations are regularly built.

    9. Testing of docs is pending

    👍🏾

    10. Make sure all the readme content of the xblocks has been moved to the `xblocks-extra` repository. We should create different read-me files for different blocks in their directories for isolation and easy maintenance.

    Agreed.

  6. farhan
    moved this from 📋 Backlog to 🔖 Ready in Aximprovements Teamon Apr 16, 2026
  7. farhan
    moved this from 🔖 Ready to 🏗 In progress in Aximprovements Teamon Apr 16, 2026
  8. farhan
    moved this from 🏗 In progress to 👀 In review in Aximprovements Teamon Apr 22, 2026
  9. farhan
    closed this as completedon Apr 27, 2026
  10. github-project-automation
    moved this from 👀 In review to ✅ Done in Aximprovements Teamon Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions