Skip to content

feat: button to publish a container [FC-0083] - #1827

Merged
ChrisChV merged 2 commits into
openedx:masterfrom
open-craft:braden/publish-container
Apr 18, 2025
Merged

feat: button to publish a container [FC-0083]#1827
ChrisChV merged 2 commits into
openedx:masterfrom
open-craft:braden/publish-container

Conversation

@bradenmacdonald

@bradenmacdonald bradenmacdonald commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

Description

Implements a minimal version of #1627

Depends on openedx/openedx-platform#36543

Private ref FAL-4069

Test Instructions

  1. Check out this PR and the required edx-platform PR.
  2. Create or paste a unit that contains multiple components (xblocks).
  3. Click on the new "Publish" button for that unit. (Note: there is no confirmation dialog.)
    a. Verify that the toast is shown:
    Screenshot 2025-04-17 at 2 35 11 PM
    b. Verify that the "Draft" badges on the preview have disappeared:
    Screenshot 2025-04-17 at 2 33 16 PM
    c. Verify that the "Unpublished Changes" badges in the search results have disappeared:
    Screenshot
  4. Make changes to a component that's in the the unit. Verify that both it and the unit now show "Unpublished Changesj" again.

Screenshots of the new Publish Button

When a unit is selected in the library, but not open - new "Publish" button:

Image

When a unit is open - same new "Publish" button:

Image

@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Apr 17, 2025
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 17, 2025
@openedx-webhooks

openedx-webhooks commented Apr 17, 2025

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/2u-tnl.

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.

1 similar comment
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/2u-tnl.

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.

@codecov

codecov Bot commented Apr 17, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.77778% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.67%. Comparing base (9adfa58) to head (52c36ff).
Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
src/library-authoring/units/LibraryUnitBlocks.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1827   +/-   ##
=======================================
  Coverage   93.66%   93.67%           
=======================================
  Files        1142     1142           
  Lines       23423    23447   +24     
  Branches     5039     5043    +4     
=======================================
+ Hits        21940    21964   +24     
+ Misses       1415     1407    -8     
- Partials       68       76    +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bradenmacdonald
bradenmacdonald force-pushed the braden/publish-container branch 3 times, most recently from fe3a1b6 to 180eed3 Compare April 17, 2025 21:43
@bradenmacdonald
bradenmacdonald force-pushed the braden/publish-container branch from 7940804 to 52c36ff Compare April 17, 2025 23:14
@bradenmacdonald
bradenmacdonald marked this pull request as ready for review April 17, 2025 23:25

@pomegranited pomegranited left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 Works beautifully, thank you @bradenmacdonald !

  • I tested this using the PR test instructions
  • 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

@ChrisChV
ChrisChV merged commit ea0a031 into openedx:master Apr 18, 2025
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Apr 18, 2025
@ChrisChV
ChrisChV deleted the braden/publish-container branch April 18, 2025 14:34
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.

4 participants