Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: endpoint to publish single library component #35677

Merged
merged 4 commits into from
Oct 21, 2024
Merged

feat: endpoint to publish single library component #35677

merged 4 commits into from
Oct 21, 2024
+80 −8

Conversation

DanielVZ96
Copy link
Contributor

@DanielVZ96 DanielVZ96 commented Oct 19, 2024 •
edited
Loading

Description

Implements and enables the publish button functionality in the libraries v2 component sidebar.

Supporting information

Testing instructions

Deadline

ASAP

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 19, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 19, 2024 •
edited
Loading

Thanks for the pull request, @DanielVZ96!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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.

@DanielVZ96 DanielVZ96 changed the title Dvz/publish single component feat: publish single component api Oct 19, 2024
@DanielVZ96 DanielVZ96 changed the title feat: publish single component api feat: publish single library component api Oct 19, 2024
@DanielVZ96 DanielVZ96 changed the title feat: publish single library component api feat: endpoint to publish single library component Oct 19, 2024
@bradenmacdonald
Copy link
Contributor

Looks great so far!

@DanielVZ96 DanielVZ96 mentioned this pull request Oct 21, 2024
Merged
@DanielVZ96 DanielVZ96 marked this pull request as ready for review October 21, 2024 18:19
bradenmacdonald
bradenmacdonald approved these changes Oct 21, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Works well, thanks!

openedx/core/djangoapps/content_libraries/views.py
def post(self, request, usage_key_str):
key = LibraryUsageLocatorV2.from_string(usage_key_str)
api.publish_component_changes(key, request.user)
return Response({})
Copy link
Contributor

Choose a reason for hiding this comment

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

In the future, we might make this return the updated metadata for the block.

We could also add a "revert single component" API by sending a DELETE request to this same endpoint.

This is good for now though :)

@bradenmacdonald bradenmacdonald enabled auto-merge (squash) October 21, 2024 19:19
@bradenmacdonald bradenmacdonald merged commit a49110b into openedx:master Oct 21, 2024
48 checks passed
@bradenmacdonald bradenmacdonald deleted the dvz/publish-single-component branch October 21, 2024 19:20
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

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

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@DanielVZ96 @openedx-webhooks @bradenmacdonald @edx-pipeline-bot