Skip to content

feat!: Bump xblocks-contrib to install PDF block by default#38055

Merged
kdmccormick merged 1 commit intoopenedx:masterfrom
open-craft:fox/bump-xblocks-contrib
Feb 26, 2026
Merged

feat!: Bump xblocks-contrib to install PDF block by default#38055
kdmccormick merged 1 commit intoopenedx:masterfrom
open-craft:fox/bump-xblocks-contrib

Conversation

@Kelketek
Copy link
Contributor

@Kelketek Kelketek commented Feb 26, 2026

Description

This merge request bumps xblocks-contrib to the latest version.

BREAKING CHANGE: The `pdf` XBlock is now built into the platform core and
installed by default. If you previously installed a third-party pdf
implementation such as https://github.com/open-craft/xblock-pdf, then the
built-in implementation will likely work as a drop-in replacement, so you can
uninstall the third-party implementation. However, if you’d rather continue
using a third-party pdf implementation, then use the `xblock.v1.overrides`
entrypoint. In either case, the third-party implementation must be removed from
the `xblock.v1` entrypoint, otherwise you will see an AmbiguousPluginError.

Supporting information

openedx/xblocks-contrib#148

Visual changes

image image image

Further refinements to the PDF block (including file uploads) will be contributed to frontend-app-authoring. For now, we're porting the existing interface.

Testing instructions

  1. Add "pdf" to the advanced modules list for a course
  2. Add a PDF block to the course using the advanced modules list.
  3. Verify that the block shows up as expected.

Deadline

Sooner's better than later.

Other information

https://openedx.atlassian.net/wiki/spaces/OEPM/pages/5335908397/Proposal+Add+PDF+Block+to+Base+Installation

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 26, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @Kelketek!

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

@Kelketek
Copy link
Contributor Author

@kdmccormick Ready for you here.

@Kelketek Kelketek force-pushed the fox/bump-xblocks-contrib branch from 61e33dc to 5657d2e Compare February 26, 2026 21:08
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

🚀

@kdmccormick
Copy link
Member

@Kelketek , I'm merging this as a breaking change, just because it's so common for instances to install a third-party pdf and this would cause an error for them.

feat!: Bump xblocks-contrib to install PDF block by default

BREAKING CHANGE: The `pdf` XBlock is now built into the platform core and
installed by default. If you previously installed a third-party pdf
implementation such as https://github.com/open-craft/xblock-pdf, then the
built-in implementation will likely work as a drop-in replacement, so you can
uninstall the third-party implementation. However, if you’d rather continue
using a third-party pdf implementation, then use the `xblock.v1.overrides`
entrypoint. In either case, the third-party implementation must be removed from
the `xblock.v1` entrypoint, otherwise you will see an AmbiguousPluginError.

and I added a Verawood operator note: https://openedx.atlassian.net/wiki/spaces/COMM/pages/5331222534/Verawood+-+Operator+Release+Notes#Default-Changes-for-Verawood

Let me know if you think I missed anything!

@kdmccormick kdmccormick merged commit e1757eb into openedx:master Feb 26, 2026
65 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Feb 26, 2026
@kdmccormick kdmccormick changed the title chore: bump xblocks-contrib feat!: Bump xblocks-contrib to install PDF block by default Feb 26, 2026
@Kelketek
Copy link
Contributor Author

Thanks so much, @kdmccormick ! That note looks great. :)

@Kelketek Kelketek deleted the fox/bump-xblocks-contrib branch February 26, 2026 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants