Automated cloud preview environments at Pull Request

[grigduta]

Summary

I would like to propose the integration of automated preview environments at pull requests in Magento2. This feature would allow contributors to have a dedicated environment automatically created for each pull request, enabling them to test their changes in a controlled environment. It would streamline the review process, enhance collaboration, and reduce the risk of introducing bugs or regressions.

Examples

When a contributor opens a pull request, the core maintainers are reviewing it directly from code or are forced to pull the changes locally, build the project and then test the changes, which is time consuming.

Proposed solution

We'd like to contribute with the functionality, implementation and infrastructure costs to enable maintainers to access the Pull Request changes in a cloud environment deployed independently from that specific branch.

Technically, the projects needs Docker files, a 'bunnyshell.yaml' and a Github Actions workflow which Bunnyshell will implement as part of our initiative.

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @dakar91. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-November]

Hi @dakar91 ,
Thank you for reporting and collaboration. We have gone through the main description and found that this is not related to any bug related to Magento. But it can be a good feature to have. Hence marking this ticket as a feature request to process further.

[grigduta]

Additional context:

Example workflow - https://github.com/aris-bunnyshell/demo-books-php/tree/main/.github/workflows
Example configuration - https://github.com/aris-bunnyshell/demo-books-php/blob/main/.bunnyshell/templates/docker-compose/bunnyshell.yaml

We really think some of the issues and PRs can benefit from preview environments, like the 161 open issues which are UI related: https://github.com/magento/magento2/labels?q=ui

[dobralin]

@engcom-Hotel @engcom-November Quick follow-up on this feature request from 2 years ago.

We'd still love to help implement automated preview environments per pull request for Magento2 - entirely for free, as a contribution to the community.

Since then, we've improved the setup flow and supported similar integrations in large open source projects like Sylius and ArgoCD .

Example of PR environment:

It’s especially valuable for API and UI-related PRs, which Magento has many of, where visual and interactive validation is important.

We’re still happy to:

• provide the full setup (GitHub Actions, Docker, Bunnyshell config)

• open a draft PR for discussion

• cover all infrastructure costs

Let us know if this is still of interest, we’re standing by and happy to contribute! 🙌