Skip to content

Conversation

@pomegranited
Copy link
Contributor

Description

Adds events related to libraries v2 containers, e.g. units, sections

Supporting information

Part of: openedx/frontend-app-authoring#1703
Blocks: openedx/openedx-platform#36371
Private-ref: FAL-4052

Testing instructions

Unit tests and coverage should be sufficient for testing this change.

Deadline

ASA

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Any other PRs or issues that should be linked here? Any related PRs?
  • Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.

Checklists

Check off if complete or not applicable:

Merge Checklist:

  • All reviewers approved
  • Reviewer tested the code following the testing instructions
  • CI build is green
  • Version bumped
  • Changelog record added with short description of the change and current date
  • Documentation updated (not only docstrings)
  • Integration with other services reviewed
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

  • Create a tag
  • Create a release on GitHub
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)
  • Upgrade the package in the Open edX platform requirements (if applicable)

@pomegranited pomegranited requested a review from a team March 16, 2025 01:33
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 16, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

This repository is currently maintained by @openedx/hooks-extension-framework.

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.


Attributes:
library_key (LibraryLocatorV2): a key that represents a content library.
container_key (str): identifies the container within the library's learning package (e.g. unit, section)
Copy link
Member

Choose a reason for hiding this comment

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

[non-blocking] Should this have its own type, like LibraryLocator or CourseKey, instead of being a plain str? This question also applies for the collection_key in LibraryCollectionData.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can use only the LibraryContainerLocator for the Container events. CC @pomegranited

For the Collections, the events were created before we had a LibraryCollectionLocator, so we needed the LibraryLocator and the collection_key: str to reference it. This can be fixed later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mariajgrimaldi Ya, as noted, making that change is blocked on openedx/opaque-keys#369, but we'd be happy to fix this in a follow-up.

Copy link
Member

@mariajgrimaldi mariajgrimaldi Mar 18, 2025

Choose a reason for hiding this comment

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

@pomegranited @rpenido: agreed! Thank you for pointing me to openedx/opaque-keys#369

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Mar 17, 2025
@mariajgrimaldi mariajgrimaldi merged commit 77d67b0 into openedx:main Mar 18, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Mar 18, 2025
@mariajgrimaldi
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project 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.

5 participants