Skip to content

Set up your account

From GitHub Actions

When you run a GitHub Actions workflow that calls the Uffizzi preview action, a Uffizzi account will be automatically created from your GitHub username. This happens because Uffizzi receives a signed OIDC token from GitHub that verifies your identity. There is no need to create a Uffizzi account before running the workflow. Afterwards when you sign in to, you will see that your account already exists.


When a preview workflow is first merged into your default branch, the workflow run will fail. This is expected behavior since the preview workflow must be initiated from the default branch of the base repository. That is, this workflow must first be merged into the default branch for subsequent workflow runs to succeed.


You can alternatively go to and use the Sign up with GitHub button to create an account with your GitHub login. When you do this, you will be redirected to the GitHub OAuth page, which includes a warning that Uffizzi may "Act on your behalf" (See screenshot below). Note that this is part of the standard permissions for GitHub OAuth. The warning is misleading because Uffizzi is only requesting read-only access to your email address and username at this step to set up your account.

After selecting Authorize Uffizzi Cloud, you are asked to Install & Authorize the Uffizzi GitHub App, where you can see which permissions Uffizzi is requesting. Uffizzi requests only the minimum permissions it needs. The only way Uffizzi acts on your behalf is by commenting on PRs.