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

Jetpack Blocks: Migrate the Timeline block from ETK #38255

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

arthur791004
Copy link
Contributor

@arthur791004 arthur791004 commented Jul 9, 2024

Related to https://github.com/Automattic/dotcom-forge/issues/8032, https://github.com/Automattic/dotcom-forge/issues/8036

Proposed changes:

  • Migrate the Timeline block to Jetpack Blocks
Editor Frontend
image image

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Apply changes to your site
  • Go to the editor
  • Insert the Timeline block
  • Add any timeline entry
  • Configure the Alternative setting of the Timeline block
    image
  • Configure the left/right setting of the Timeline Entry block
    image
  • Configure the background color of the Timeline Entry block
    image
  • Make sure everything works as expected
  • Preview your changes
  • Make sure the Timeline block looks good on your frontend page
Copy link
Contributor

github-actions bot commented Jul 9, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the feat/jetpack-timeline-block branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack feat/jetpack-timeline-block
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2
@github-actions github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Block] Timeline labels Jul 9, 2024
Copy link
Contributor

github-actions bot commented Jul 9, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 9, 2024
@arthur791004 arthur791004 requested a review from a team July 10, 2024 06:22
@arthur791004 arthur791004 removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 10, 2024
@arthur791004 arthur791004 self-assigned this Jul 10, 2024
@okmttdhr
Copy link
Member

I may not be up to date 🙏, but could you explain why this uses the jetpack/extensions/blocks directory instead of jetpack-mu-wpcom? Will this block be available only to wpcom?

Copy link
Member

@okmttdhr okmttdhr left a comment

Choose a reason for hiding this comment

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

The block worked as expected for me 👍

@arthur791004
Copy link
Contributor Author

I may not be up to date 🙏, but could you explain why this uses the jetpack/extensions/blocks directory instead of jetpack-mu-wpcom? Will this block be available only to wpcom?

These blocks are designed for Jetpack but they were implemented in ETK plugin first. So, I think it makes sense to migrate them to Jetpack. See Automattic/wp-calypso#37889

Copy link
Contributor

@taipeicoder taipeicoder left a comment

Choose a reason for hiding this comment

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

Works nicely 👍

@arthur791004 arthur791004 merged commit da8c335 into trunk Jul 10, 2024
58 checks passed
@arthur791004 arthur791004 deleted the feat/jetpack-timeline-block branch July 10, 2024 12:01
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 10, 2024
@jeherve jeherve added the [Status] Needs Testing We need to add this change to the testing call for this month's release label Jul 11, 2024
@ChrisBegley
Copy link

Hello, the release notes for 13.7 say that the Event Countdown and Timeline blocks were added: https://wordpress.org/plugins/jetpack/#developers

However, I don't see these blocks on my websites running Jetpack 13.7. I confirmed that I have "Jetpack Blocks" turned on under "Jetpack Settings > Writing > Composing"

This is a problem on multiple websites across multiple hosts, including locally with WordPress.com Studio.

@arthur791004
Copy link
Contributor Author

arthur791004 commented Aug 7, 2024

Referring to https://github.com/Automattic/dotcom-forge/issues/8036#issuecomment-2222306034, we moved those blocks to jetpack-mu-wpcom so it's only available on atomic sites with the mu-wpcom plugin.

@ChrisBegley
Copy link

@arthur791004 I see, so what does a self-hosted Jetpack user need to do to use the new Timeline block?

@arthur791004
Copy link
Contributor Author

arthur791004 commented Aug 7, 2024

The blocks in Jetpack will be shipped in a new Jetpack Extras plugin instead.

As discussion, we don't want to expose blocks in the Jetpack plugin. If the Timeline block is useful for Jetpack users, I think we can consider to include the Timeline block in the new Jetpack Extras plugin in the future cc @jeherve

@ChrisBegley
Copy link

@arthur791004 thanks for the clarification, I don't have access to this page: https://github.com/Automattic/dotcom-forge/issues/8036

I guess I'm confused by the WordPress.org changelog for Jetpack 13.7. It says: https://wordpress.org/plugins/jetpack/#developers

Changelog
13.7 – 2024-08-06
Enhancements
Blocks: Add the EventCoutdown block.
Blocks: Add the Timeline block.

But those blocks aren't actually available to be used? They'll be coming later to a new Jetpack Extras plugin?

@arthur791004
Copy link
Contributor Author

arthur791004 commented Aug 7, 2024

But those blocks aren't actually available to be used? They'll be coming later to a new Jetpack Extras plugin?

It's a mistake we forgot to remove that changelog 🙈 Now it's only for WordPress.com users

@ChrisBegley
Copy link

Ohh ok. Thanks for clearing that up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Timeline [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Testing We need to add this change to the testing call for this month's release
5 participants