Skip to main content

FAQ

In this section, we will provide answers to frequently asked questions about Argos.

How to invite someone to my Argos repository?​

The GitHub repositories' user access are mirrored from GitHub: A user that have access to your repository on GitHub, will have access on Argos too. To provide access to your private repository on Argos, you have to give him access on GitHub. If the repository doesn't show up in his list, he can force the refresh by log out and log in.

Everyone has access to Argos public repositories.

How do I update the screenshot comparison baseline?​

Argos updates the comparison baseline screenshots when a commit is merged into the repository's reference branch. You need to run Argos on your reference branch.

What is a reference branch?​

A reference branch is the branch used as the baseline for the screenshot comparisons. Argos automatically uses the default branch of your GitHub repository as the reference branch, but you can set another branch in Argos repository settings.

How do I change the reference branch?​

You can change the reference branch in Argos repository settings.

What is an orphan build?​

An orphan build is the first build performed on a reference branch. It won't show any comparison. The screenshots of this build will be considered as the baseline for the following comparisons.

What is a reference build?​

A reference build is a build created from a CI running on a commit pushed to your reference branch. Reference builds are used as the baseline for branches created from this commit. Argos automatically chooses the best reference build by analyzing the commit history.

Why share repositories with Argos?​

When you install the Argos app on GitHub, you'll be asked to share your repositories. This allows Argos to create a list of your repositories and find reference builds to compare against each pull request. It also helps keep the authorized user list synchronized automatically.

How do I update the repositories list shared with Argos?​

Once you have installed the Argos app on GitHub, you can adjust the list of repositories that are shared with Argos. Here's how to do it:

  1. Go to GitHub's installations settings
  2. Select the account you want to configure
    Argos build example
  3. Click the Configure button next to Argos installation.
  4. Under "Repository access," select "Only select repositories" and choose the repositories you want to share with Argos.
    Argos build example

What app permissions does Argos require?​

Argos requires the following GitHub app permissions to function:

  • Contents — used to find a common commit ancestor between branches
  • Statuses — used to add statuses to commits
  • Pull requests — used to add comments in pull requests
  • Actions — used to allow tokenless authentication

We take your security and privacy seriously. If you have any concerns or questions, please don't hesitate to contact us.