Skip to content

Create a GitHub Environment for your previews

GitHub Environments are a convenient way to collect all of your previews in a single view on GitHub. Specifically, GitHub Environments are the target of your workflows, so you can configure a "uffizzi" Environment to be the target of your ephemeral preview deployments. You'll also see these deployments appear in your Actions workflow graph.

Set up a "uffizzi" GitHub Environment

If you're using the standard Uffizzi reusable workflow to create, update, and delete environments on pull request events, then you just need to create a GitHub Environment called "uffizzi" in your reposiory via the GitHub UI. The reusable workflow is pre-configured to populate this Environment with Uffizzi preview deployments. If you're not using the resuable workflow, you'll need to configue the jobs.<job-id>.environment key as described here.

Login to GitHub, then navigate to your repository Settings > Environments and select New environment. For the Environmnet name enter "uffizzi". Note that if you name it something else, it won't work since the reusable workflow expects the enviroment to be named "uffizzi".

That's it! You can now select the "uffizzi" Environment to see the new Deployments that are created every time your Uffizzi workflow runs.