Skip to content

Commit e42e965

Browse files
ZIJmotatoesbismuthdev[bot]
authored
Update docs to point to ui.digger.dev (#2024)
* Update docs to point to ui.digger.dev * Update docs/ce/getting-started/github-actions-+-aws.mdx * Update docs/ce/getting-started/github-actions-+-aws.mdx * Update docs/ce/getting-started/github-actions-and-gcp.mdx * Update docs/ce/getting-started/github-actions-and-gcp.mdx * Update docs/ce/getting-started/github-actions-and-gcp.mdx Co-authored-by: bismuthdev[bot] <177057995+bismuthdev[bot]@users.noreply.github.com> * Update docs/ce/getting-started/github-actions-and-gcp.mdx Co-authored-by: bismuthdev[bot] <177057995+bismuthdev[bot]@users.noreply.github.com> * Update github-actions-+-aws.mdx --------- Co-authored-by: Mohamed Habib <[email protected]> Co-authored-by: bismuthdev[bot] <177057995+bismuthdev[bot]@users.noreply.github.com>
1 parent 31c12fd commit e42e965

File tree

2 files changed

+29
-11
lines changed

2 files changed

+29
-11
lines changed

docs/ce/getting-started/github-actions-+-aws.mdx

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ In this tutorial, you will set up Digger to automate terraform pull requests usi
88

99
- A GitHub repository with valid terraform code. Here's a [demo repo](https://github.com/diggerhq/quickstart-actions-aws)
1010
- Your AWS credentials. See [Hashicorp's AWS tutorial](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/aws-build)
11-
- Digger [GitHub App](https://github.com/apps/digger-cloud/installations/select_target) installed
11+
12+
# Step 1: create your Digger account
13+
14+
Head to [ui.digger.dev](https://ui.digger.dev) and sign up using your preferred method.
15+
16+
You should see onboarding screen after you sign up, which guides you to install the github app and perform the next steps
17+
18+
# Step 2: install the Digger GitHub App
19+
20+
Install the Digger [GitHub App](https://github.com/apps/digger-pro) into your repository.
1221

1322
<Note>
1423
Digger GitHub App does not need access to your cloud account, it just starts jobs in your CI. All sensitive data stays in your CI job.
@@ -17,14 +26,14 @@ You can also [self-host Digger orchestrator](/ce/self-host/deploy-docker) with a
1726

1827
</Note>
1928

20-
# Create Action Secrets with AWS credentials (you can also [use OIDC](/ce/cloud-providers/authenticating-with-oidc-on-aws))
29+
# Step 3: Create Action Secrets with AWS credentials (you can also [use OIDC](/ce/cloud-providers/authenticating-with-oidc-on-aws)
2130

2231
In GitHub repository settings, go to Secrets and Variables - Actions. Create the following secrets:
2332

2433
- `AWS_ACCESS_KEY_ID`
2534
- `AWS_SECRET_ACCESS_KEY`
2635

27-
# Create digger.yml
36+
# Step 4: Create digger.yml
2837

2938
This file contains Digger configuration and needs to be placed at the root level of your repository. Assuming your terraform code is in the `prod` directory:
3039

@@ -34,7 +43,7 @@ projects:
3443
dir: prod
3544
```
3645

37-
# Create Github Actions workflow file
46+
# Step 5: Create Github Actions workflow file
3847

3948
Place it at `.github/workflows/digger_workflow.yml` (name is important!)
4049

@@ -78,7 +87,7 @@ jobs:
7887
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7988
```
8089

81-
# Create a PR to verify that it works
90+
# Step 6: Create a PR to verify that it works
8291

8392
Terraform will run an existing plan against your code.
8493

docs/ce/getting-started/github-actions-and-gcp.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ In this tutorial, you will set up Digger to automate terraform pull requests usi
88

99
- A GitHub repository with valid terraform code. Here's a [demo repo](https://github.com/diggerhq/demo-conftest-gcp/) for inspiration.
1010
- A GCP Service Account Key json file. See [Hashicorp's GCP tutorial](https://developer.hashicorp.com/terraform/tutorials/gcp-get-started/google-cloud-platform-build)
11-
- Digger [GitHub App](https://github.com/apps/digger-cloud/installations/select_target) installed
11+
12+
# Step 1: create your Digger account
13+
14+
Head to [ui.digger.dev](https://ui.digger.dev) and sign up using your preferred method.
15+
16+
You should see onboarding screen after you sign up, which guides you to install the github app and perform the next steps
17+
18+
# Step 2: install the Digger GitHub App
19+
20+
Install the Digger [GitHub App](https://github.com/apps/digger-pro) into your repository.
1221

1322
<Note>
1423
Digger GitHub App does not need access to your cloud account, it just starts jobs in your CI. All sensitive data stays in your CI job.
@@ -17,13 +26,13 @@ You can also [self-host Digger orchestrator](/self-host/deploy-docker) with a pr
1726

1827
</Note>
1928

20-
# Create Action Secrets
29+
# Step 3: Create Action Secrets
2130

2231
In GitHub repository settings, go to Secrets and Variables - Actions. Create the following secrets:
2332

24-
- `GCP_CREDENTIALS` - contents of your GCP Service Account Key json file. You can also [use OIDC](/gcp/federated-oidc-access/))
33+
- `GCP_CREDENTIALS` - contents of your GCP Service Account Key json file. You can also [use OIDC](/ce/gcp/federated-oidc-access/)
2534

26-
# Create digger.yml
35+
# Step 4: Create digger.yml
2736

2837
This file contains Digger configuration and needs to be placed at the root level of your repository. Assuming your terraform code is in the `prod` directory:
2938

@@ -33,7 +42,7 @@ projects:
3342
dir: prod
3443
```
3544

36-
# Create Github Actions workflow file
45+
# Step 5: Create Github Actions workflow file
3746

3847
Place it at `.github/workflows/digger_workflow.yml` (name is important!)
3948

@@ -93,7 +102,7 @@ This file defines a workflow with 5 steps:
93102
- Verify that GCP is configured correctly by running `gcloud info`
94103
- Run Digger.
95104

96-
# Create a PR to verify that it works
105+
# Step 6: Create a PR to verify that it works
97106

98107
Make any change to your terraform code e.g. add a blank line. An action run should start (you can see log output in Actions). After some time you should see output of Terraform Plan added as a comment to your PR:
99108

0 commit comments

Comments
 (0)