Skip to content

Commit c33e09c

Browse files
authored
feat: document GitHub no content access (#134)
1 parent 2beb5b3 commit c33e09c

7 files changed

+41
-22
lines changed

docs/git-providers/github.mdx

+41-22
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,56 @@ title: GitHub
44
sidebar_position: 30
55
---
66

7-
import githubRepoAccess from "@site/src/img/github-repo-access.png";
8-
97
# Integrating Argos with GitHub
108

11-
Seamlessly integrate Argos with GitHub for automated visual testing directly within your workflow. Connect and receive instant feedback on PRs.
9+
Seamlessly integrate Argos with GitHub for automated visual testing directly within your workflow. Connect Argos to your repositories and receive instant feedback on your pull requests, making it easier to maintain visual consistency across your project.
10+
11+
## GitHub Connect
12+
13+
Use GitHub Connect to log in to Argos with your GitHub account. This integration allows Argos to access your repositories and streamline the setup process.
14+
15+
## Argos' GitHub App
16+
17+
Argos provides a dedicated GitHub App that connects directly to your repositories, enabling real-time visual testing feedback on pull requests.
18+
19+
### Install the Argos GitHub App
20+
21+
1. Visit the [Argos app page on GitHub](https://github.com/apps/argos-ci).
22+
2. Click on "Configure" and select the organization where you want to install Argos.
23+
3. Follow the prompts to complete the installation.
24+
25+
### Import a GitHub Repository to Argos
26+
27+
1. Sign in to Argos and click on "Create a new project".
28+
2. Choose GitHub as your provider, then click "Import your repository."
29+
30+
### Update the Repositories Shared with Argos
31+
32+
1. Go to the [Argos app page on GitHub](https://github.com/apps/argos-ci) and click "Configure".
33+
2. Select the organization where you want to manage repository access.
34+
3. Under "Repository access," choose "Only select repositories" and select the specific repositories you wish to share with Argos.
35+
36+
![Required Argos status check in GitHub](./github/repository-access.jpg)
1237

13-
## 1. GitHub Connect
38+
## GitHub Integration without Content Permission
1439

15-
GitHub Connect to log in into Argos.
40+
If you prefer to use Argos without granting full content access to your repositories, you can now integrate via a more restricted setup.
1641

17-
## 2. Argos' GitHub App
42+
### Setting Up Argos with Limited GitHub Access
1843

19-
Argos has a dedicated GitHub App to connect to your repositories and provide real-time feedback on pull requests.
44+
1. Navigate to Team Settings in your Argos dashboard.
45+
2. In the "GitHub without content access" section, click Install GitHub App.
2046

21-
#### Install
47+
![GitHub without content access settings in Argos](./github/github-light-settings.jpg)
2248

23-
Visit the [Argos app page on GitHub](https://github.com/apps/argos-ci), click on "Configure" and choose the organization for Argos installation.
49+
3. On the next screen you are redirected to GitHub, choose the specific repositories where you want to install the Argos app.
2450

25-
#### Import GitHub Repository to Argos
51+
![Argos GitHub app without content access](./github/github-light-app.jpg)
2652

27-
1. Sign in to Argos and click on "Create a new project"
28-
2. Choose your Git provider and click on "import your repository".
53+
4. Go to Team Projects in Argos.
54+
5. Click Create a new project.
55+
6. Select Continue with GitHub (no-content access).
2956

30-
#### Update the repositories list shared with Argos
57+
![Argos GitHub app without content access](./github/create-project.jpg)
3158

32-
1. Head to the [Argos app page on GitHub](https://github.com/apps/argos-ci) and select "Configure".
33-
2. Select the organization you aim to adjust.
34-
3. Under "Repository access" select "Only select repositories" and choose the repositories you want to share with Argos.<br/>
35-
<img
36-
src={githubRepoAccess}
37-
alt="Argos build example"
38-
className="rounded"
39-
style={{ marginBottom: 4, marginTop: 8, width: 450 }}
40-
/>
59+
7. Choose the repository you want to connect.
42 KB
Loading
65.6 KB
Loading
Loading
31.3 KB
Loading
-19.3 KB
Binary file not shown.

src/img/github-repo-access.png

-141 KB
Binary file not shown.

0 commit comments

Comments
 (0)