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 AI Image: Automatically start generation of featured image when there is content on the post #38262

Merged

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Jul 9, 2024

This is reverting part of #38098 so we only trigger the generation automatically when there is content on the post. When there is no content, the user will see the modal open with the empty state on it.

Proposed changes:

  • Enable featured image auto start when there is content on the post

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

p1720141077573849-slack-C054LN8RNVA

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

Testing instructions:

Let's test the first scenario: no content on the post.

  • Run this branch on your testing site (or a fresh JN site)
  • Go to the block editor and do not add any content
  • Look for the featured image button on the Jetpack sidebar (Jetpack sidebar > AI Assistant section > AI Featured Image > Generate Image)
  • Click the button and confirm the tool will open, the generation will not start and you see the proper empty state:
Screenshot 2024-07-09 at 12 47 37
  • Do the same test for the other 2 placements:
    • Settings sidebar > Post tab > AI Assistant section > AI Featured Image > Generate Image button
    • Settings sidebar > Post tab > Featured Image section (or summary section, depending on the Gutenberg version) > Set featured image button
    • Remember to not add content to the post while testing it and confirm you only see the modal showing the empty state, with no generation going on
  • Confirm you still can type some prompt and generate images based on it

Now let's test the second scenario: a post with content.

  • Add some content to the post (tip: use the AI Assistant to generate two paragraphs about some topic)
  • Look for the featured image button on the Jetpack sidebar (Jetpack sidebar > AI Assistant section > AI Featured Image > Generate Image)
  • Click the button and confirm the tool will open and the generation will start automatically
  • You should see a loading state and then, after some time, the new generated image:
The loading state The generated image
Screenshot 2024-07-09 at 12 49 10 Screenshot 2024-07-09 at 12 50 22
  • Close the generation tool and do the same test for the other 2 placements:
    • Settings sidebar > Post tab > AI Assistant section > AI Featured Image > Generate Image button
    • Settings sidebar > Post tab > Featured Image section (or summary section, depending on the Gutenberg version) > Set featured image button
    • Confirm you see the modal with the loading state, followed by the new image being showed
  • Confirm you still can type a custom prompt and generate images based on it, after the first one got generated
@lhkowalski lhkowalski requested a review from a team July 9, 2024 15:48
@lhkowalski lhkowalski self-assigned this Jul 9, 2024
@lhkowalski lhkowalski added [Status] In Progress [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 9, 2024
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 update/jetpack-ai-featured-image-auto-start-generation branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-featured-image-auto-start-generation
    

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
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.

@lhkowalski lhkowalski marked this pull request as ready for review July 9, 2024 15:53
@lhkowalski lhkowalski added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Jul 9, 2024
Copy link
Contributor

@CGastrell CGastrell left a comment

Choose a reason for hiding this comment

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

LGTM! Works as described :shipit:

@lhkowalski lhkowalski merged commit b615c43 into trunk Jul 9, 2024
60 of 61 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-featured-image-auto-start-generation branch July 9, 2024 18:30
@github-actions github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Jul 9, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
2 participants