Preview URLs
Learn how to provide Fume with alredy-existing preview URLs.
🚨 This feature is currently only available for Github repositories.
If you already have setup that creates an ephemeral preview environment for every PR, Fume can use that to conduct browser testing. Once configured, Fume will wait until the preview URL is available to start its review.
Requirements
- You must have a Github repository that is integrated with Fume.
- The URL for the preview environment must be sent to the pull request as a comment.
- The URL should follow a specific format. Any format that you can represent as a RegEx is okay. This may be subdomain, domain, or even a path that is included in every preview URL.
How to set it up
At this point we will assume you have already created a studio. If you are using Github, here is the quickest way to do so: Github Integration, if not refer to the Studio Setup guide.
Once you have created a studio, you can go to the Studio
tab on the left hand bar and click on the Edit
button on the card of the studio you want to use.
Click on the studio cart to edit it. There you will see a file directory. Every studio has a .fumeconfig
file in the root directory. This is a special file that you can provide custom instrctions for Fume to follow in the project. This is also critical for Fume's performance. You are highly encouraged to read the Customizing Fume guide to learn more about it. But for now, you can scroll directly down to the Preview URL
section.
Here you can provide a RegEx pattern that will be used to extract the URL from the pull request comments. Writing RegEx might be a bit tricky manually, so we highly recommend using ChatGPT or equivalent tools to generate it for you. Fume has a built-in RegEx validator.
Once you have provided the RegEx pattern, you can click on the Save
button to save the changes. PLEASE DO NOT FORGET TO SAVE THE CHANGES BEFORE EXITING THE FUMECONFIG FILE.
After you save the fumeconfig file, you can click on the Save Studio
button at the bottom of the File Explorer
section. This will re-index the studio to be ready for use for future tasks.
You will be redirected back to the Studios
page and see that your studio is now indexing. After, a few minutes, it will be ready again and fully setup for your preview URLs!