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.

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

Ensure Podcast block updates are backward compatible. #320

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

iamdharmesh
Copy link
Member

Description of the Change

PR fixes the first issue reported in #313 (comment)

I tested on an existing post that already had a Podcast block in it and I got the dreaded Block recovery error. Luckily clicking that recovery button did work but it would be ideal if this didn't happen. I know we made some big changes to the block but would be great if those changes could be made backwards compatible.

The issue occurred due to changes in the block markup. PR #272 adds a class to the figcaption and moves its position above the audio control.

This PR resolves the issue by adding deprecated block markup using the block deprecation feature.

An alternate solution would be to keep the block markup as it is, since we didn't make major changes—just moved the caption above the audio control. Keeping it as is would prevent the invalid content error.

How to test the Change

  1. Check out the 1.8.0 release tag.
  2. Create a post with a Podcast block and save it.
  3. Check out the develop branch, visit the edit post page, and notice the invalid content error on the block.
  4. Check out this PR branch, visit the edit post page, and verify that there is no invalid content error on the block.

Changelog Entry

Developer - Ensure Podcast block updates are backward compatible.

Credits

Props @dkotter @iamdharmesh

Checklist:

@iamdharmesh iamdharmesh requested a review from a team as a code owner September 20, 2024 13:58
@iamdharmesh iamdharmesh requested review from peterwilsoncc and removed request for a team September 20, 2024 13:58
@github-actions github-actions bot added this to the 1.9.0 milestone Sep 20, 2024
@github-actions github-actions bot added the needs:code-review This requires code review. label Sep 20, 2024
@iamdharmesh iamdharmesh modified the milestones: 1.9.0, 1.8.1 Sep 20, 2024
@iamdharmesh iamdharmesh mentioned this pull request Sep 20, 2024
15 tasks
@dkotter dkotter merged commit c765d1d into develop Sep 20, 2024
8 checks passed
@dkotter dkotter deleted the fix/block-recovery branch September 20, 2024 20:22
@dkotter dkotter removed the request for review from peterwilsoncc September 20, 2024 20:22
@dkotter dkotter modified the milestones: 1.8.1, 1.9.0 Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:code-review This requires code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants