vcanales/action-wp-playground-pr-preview

action-wp-playground-pr-preview's Issues

Customizable parameters

This action would be so useful to adopt in all the repositories out there. To do that, it needs to provide a degree of customization. I went through a few custom comment actions out in the wild and gathered a few things to parametrize before they can be swapped for this one:

• The comment body. It would be useful to make it a markdown template that accepts the following parameters:
  • target_repo_owner
  • target_repo_name
  • source_branch_name
  • pr_number
  • pr_url
  • ci_job_run_id
  • preview_url – based on the Blueprint below
  • preview_blueprint_hash – to link to, say, https://playground.wordpress.net/builder/builder.html#the same blueprint
• Blueprint for the preview, also possible to format with the variables above (example)

References

• https://github.com/WordPress/wordpress-develop/blob/trunk/.github/workflows/pull-request-comments.yml#L80
• https://github.com/WordPress/blueprints/blob/trunk/.github/workflows/preview-comment.yml
• https://github.com/GatherPress/gatherpress/pull/666/files#diff-4502a44b7956d5e6fb545c03eadbd0fcfa5eecc2752db489aadddbada771f5ea
• https://github.com/woocommerce/woocommerce/blob/67ab34aab2ad4dfc2f974e775d18994f559085a8/.github/workflows/pr-build-live-branch.yml#L111

Also – thank you so much for your great work here @vcanales!

Move under the WordPress GitHub organization

It would be great to offer an official WordPress reusable GitHub action. Would you be open to moving this repo under the WordPress org? This would unlock recommending it in all Playground docs and materials.

Mode switcher: New comment vs updating the issue description

It would be useful to select one of a few actions:

• Add / update a preview link at the bottom of the PR description
• Create a new comment

@youknowriad provided a good rationale for that in the related Gutenberg PR:

With this, it's going to be the sixth bot comment on PRs on Gutenberg. All of the comments are useful but their number makes it so that it's very noisy and distract a lot from the PR.

We have:

A comment to welcome new contributors
A comment to tell new contributors that they're missing the connection in WP profiles (yes, I think there are two comments for new contributors)
A comment from the props bot
A comment about the bundle size
A comment about flaky tests
A comment about modified php files
A comment about the previews on Playground
And we also discussed adding a comment about the "performance job results" (link to summary)
I like all of these comments and I actually have ideas to add more comments but this is not sustainable IMO for PR authors and reviewers. We should explore merging all of these comments into:

One pre-merge comment.
One post-merge comment.
And smartly use things like "details" to hide/show sections.

(I don't consider this comment a blocker for this PR, but I think we should explore that soonish)