Accounts and projects

Signing in#

Sign in with GitHub, then connect your GitHub account on the next screen. Signing in tells stateofpixel who you are. The connection lets it read your installations and repository permissions, so what you can see and review follows your access on GitHub. If you used stateofpixel before, connecting the same GitHub account brings back your projects, reviews and tokens.

When GitHub stops accepting the connection, for example after you revoke the app's access, stateofpixel removes it and asks you to connect again. A GitHub account can be connected to one stateofpixel user only. See Could not connect GitHub.

Accounts#

After you sign in, Accounts lists every account you can see, with its plan, the people who use it, its storage out of the plan limit, number of projects and last build. Click one to open its Overview. The Accounts link at the start of the breadcrumb on every page brings you back here. An account shows "App not installed" when the GitHub App is not installed on it anymore. With no accounts yet, the page has the button to install the app.

The account page#

The sidebar on the left has the account switcher at the top, then four pages for the account and its projects. Projects whose latest build waits for review show how many snapshots are left. Press ctrl b (cmd b on macOS) or the button at the top left to fold the sidebar into icons. On the build page it starts folded. Press cmd k (ctrl k on Windows and Linux) or Jump to at the top right to open a project, an account page, the docs or a theme by typing its name.

• Overview: the plan, storage and members, then every repository in the installation with its latest build, how far its review got and who reviewed it. Search by name, and sort by project or by last update. Press j and k to move between rows in the project and build lists, and Enter to open one.
• Members: who has connected GitHub and has access to the account.
• Usage: storage per project. See The Usage page.
• Billing: the plan and its buttons. See Billing.

Members#

The Members page lists everyone who has connected GitHub to stateofpixel and has access to the account on GitHub, with their role and when they were last active. Someone shows up once they open Accounts or any project of the account. Someone who never connected GitHub is not listed.

Access comes from GitHub, so add or remove people there. In an organization, owners on GitHub are Owner and everyone else is Member. On a personal account, the account's user is Owner and everyone else is Collaborator. Owners change the plan and delete archived projects. Repository permissions decide who can review builds and change project settings. See Who can review.

Project settings#

People with write access to the repository on GitHub open Settings under the project in the sidebar and change the diff settings. Admins also see and change the other settings. Everyone else sees the tab disabled.

• General: the default branch, which mirrors GitHub, and the auto-approve branches. See Baselines.
• Diff: the threshold, whether anti-aliased pixels count, how many changed pixels to ignore and the unstable snapshots. See Tune the threshold and Mark snapshots unstable.
• Checks: the name of the check, stateofpixel. Other suites get their own check, like stateofpixel/storybook. See Suites.
• Retention: how long images kept only for pull requests stay. See Retention.
• Tokens: project tokens for CI other than GitHub Actions. See Other CI.
• Danger: Delete project.

Delete a project#

Under Settings, Danger, type the repository name and press Delete project. Every build, review and token of the project is deleted right away, and this cannot be undone. Images that no other project uses are deleted by the next daily cleanup, which frees their storage.

CI uploads to the repository are refused after that. If the repository is still in the GitHub App installation, it comes back as an empty project after the next sync with GitHub, for example when you change the repositories of the installation. Remove the repository from the installation on GitHub to keep it out.

Remove a repository or uninstall the app#

Removing a repository from the installation on GitHub archives its project. Uninstalling or suspending the app archives every project of the account.

An archived project:

• does not show in the project list, and its pages say "Project not found."
• refuses uploads from CI, and gets no check on new commits
• keeps its builds, baselines and tokens, and its images still count toward storage. Retention still deletes old builds of pull requests and branches.
• still shows on the Usage page while it holds images, marked "Archived". Owners can delete it there.

Uninstalling does not cancel a paid plan. Cancel it under Billing first. See Cancel.

Add the repository again, or install the app again, and the project comes back with its builds, baselines and settings. To delete an archived project, an owner presses Delete next to it on the Usage page and types its name. Deleting works the same as Delete a project. For an archived project that no longer shows on the Usage page, write to us. See the privacy policy.