feat: REST API to publish the changes to a container [FC-0083] by bradenmacdonald · Pull Request #36543 · openedx/openedx-platform

bradenmacdonald · 2025-04-17T18:12:41Z

Description

Implements openedx/frontend-app-authoring#1710 . Adds new REST + python APIs into content libraries that can be used to publish a single container and its children, without publishing the whole library. Publishing "all changes in the library" is already possible.

Needed for openedx/frontend-app-authoring#1827 and can be tested using that UI.

Testing instructions

See other PR.

Deadline

ASAP - needed for Teak

Private ref FAL-4069

openedx-webhooks · 2025-04-17T18:12:46Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-edx-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.

openedx-webhooks · 2025-04-17T18:12:46Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-edx-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.

pomegranited

👍 Found one minor bug, but this is working great otherwise. Thank you @bradenmacdonald !

I tested this using the test instructions on openedx/frontend-app-authoring#1827
I read through the code
I checked for accessibility issues by using my keyboard to navigate
Includes documentation -- code comments
User-facing strings are extracted for translation

pomegranited · 2025-04-18T00:35:48Z

+    # Publish the component and update anything that needs to be updated (e.g. search index):
    authoring_api.publish_from_drafts(learning_package.id, draft_qset=drafts_to_publish, published_by=user.id)
    LIBRARY_BLOCK_UPDATED.send_event(
        library_block=LibraryBlockData(


If we also raise LIBRARY_CONTAINER_UPDATED for affected containers here like we do here, then it'll handle this case:

Edit a Component in a Unit:

Component + Unit show "unpublished changes" ✔️

Publish the Component only.

Component no longer shows "unpublished changes" ✔️

Unit no longer shows "unpublished changes" ❌

Fixed with c0972ef.

Nice, thanks for identifying and fixing that!

for components in containers.

…ainers

edx-pipeline-bot · 2025-04-18T06:15:02Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-04-18T06:40:23Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-04-18T06:40:23Z

2U Release Notice: This PR has been deployed to the edX production environment.

…enedx#36543) * feat: REST API to publish the changes to a container * fix: trigger LIBRARY_CONTAINER_UPDATED when component published for components in containers. --------- Co-authored-by: Jillian Vogel <jill@opencraft.com>

…6543) * feat: REST API to publish the changes to a container * fix: trigger LIBRARY_CONTAINER_UPDATED when component published for components in containers. --------- Co-authored-by: Jillian Vogel <jill@opencraft.com>

bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Apr 17, 2025

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 17, 2025

openedx-webhooks added this to Contributions Apr 17, 2025

github-project-automation Bot moved this to Needs Triage in Contributions Apr 17, 2025

bradenmacdonald mentioned this pull request Apr 17, 2025

feat: button to publish a container [FC-0083] openedx/frontend-app-authoring#1827

Merged

bradenmacdonald force-pushed the braden/publish-containers branch from 20fffa8 to 8ea7b0a Compare April 17, 2025 20:14

feat: REST API to publish the changes to a container

e82bbc6

bradenmacdonald force-pushed the braden/publish-containers branch from 8ea7b0a to e82bbc6 Compare April 17, 2025 21:12

test: tests for new publish container functionality

d7fa581

bradenmacdonald force-pushed the braden/publish-containers branch from 2933f2f to d7fa581 Compare April 17, 2025 23:15

bradenmacdonald requested a review from pomegranited April 17, 2025 23:26

pomegranited approved these changes Apr 18, 2025

View reviewed changes

pomegranited added 2 commits April 18, 2025 11:45

fix: trigger LIBRARY_CONTAINER_UPDATED when component published

c0972ef

for components in containers.

Merge remote-tracking branch 'origin/master' into braden/publish-cont…

480b110

…ainers

bradenmacdonald merged commit 334c0fe into openedx:master Apr 18, 2025

bradenmacdonald deleted the braden/publish-containers branch April 18, 2025 05:05

github-project-automation Bot moved this from Needs Triage to Done in Contributions Apr 18, 2025

ormsbee mentioned this pull request Apr 23, 2025

Remove py2neo dependency #36586

Merged

Navigation Menu

Uh oh!

feat: REST API to publish the changes to a container [FC-0083] - #36543

feat: REST API to publish the changes to a container [FC-0083]#36543
bradenmacdonald merged 4 commits into
openedx:masterfrom
open-craft:braden/publish-containers

bradenmacdonald commented Apr 17, 2025

Uh oh!

openedx-webhooks commented Apr 17, 2025

Uh oh!

openedx-webhooks commented Apr 17, 2025

Uh oh!

pomegranited left a comment

Uh oh!

pomegranited Apr 18, 2025 •

edited

Loading

Uh oh!

pomegranited Apr 18, 2025

Uh oh!

bradenmacdonald Apr 18, 2025

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

bradenmacdonald commented Apr 17, 2025

Description

Testing instructions

Deadline

Uh oh!

openedx-webhooks commented Apr 17, 2025

Uh oh!

openedx-webhooks commented Apr 17, 2025

Uh oh!

pomegranited left a comment

Choose a reason for hiding this comment

Uh oh!

pomegranited Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pomegranited Apr 18, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 18, 2025

Choose a reason for hiding this comment

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

edx-pipeline-bot commented Apr 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pomegranited Apr 18, 2025 •

edited

Loading