Skip to content

Commit 571990e

Browse files
authored
fix/docs reverting (#1663)
* Revert "Docs: restructure to Team and EE tabs" This reverts commit 5e8fdf5. * fix docs quickstart and broken links
1 parent 4dae08d commit 571990e

22 files changed

+93
-90
lines changed

docs/ce/cloud-providers/authenticating-with-oidc-on-aws.mdx

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,36 @@ title: "Authenticating with OIDC on AWS"
55
In order to set up OIDC simply swap the AWS Keys with assume role ARN and you are good to go. Here is an example, don't forget to replace the line starting in \*\* with your own ARN for the account.
66

77
```
8-
...
8+
name: Digger Workflow
99
10-
jobs:
11-
digger-job:
10+
on:
11+
workflow_dispatch:
12+
inputs:
13+
run_name:
14+
required: false
15+
spec:
16+
required: true
17+
18+
run-name: '${{inputs.run_name}}'
1219
13-
...
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
permissions:
24+
contents: write # required to merge PRs
25+
id-token: write # required for workload-identity-federation
26+
pull-requests: write # required to post PR comments
27+
statuses: write # required to validate combined PR status
1428
1529
steps:
1630
- name: digger run
1731
uses: diggerhq/digger@vLatest
1832
with:
33+
digger-spec: ${{ inputs.spec }}
1934
setup-aws: true
20-
aws-role-to-assume: arn:aws:iam::{AccountID}:role/{RoleName}
35+
**aws-role-to-assume: arn:aws:iam::{AccountID}:role/{RoleName}**
2136
aws-region: us-east-1
22-
23-
...
24-
37+
env:
38+
GITHUB_CONTEXT: ${{ toJson(github) }}
39+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2540
```

docs/ce/features/plan-persistence.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: "Plan Persistence"
33
---
44

5-
By default digger will run an apply based on the branch pull request files (no artefacts stored). In order to configure plan artefacts you can configure the inputs for storing as github artefacts or aws buckets or gcp buckets. The corresponding artefacts to be configured can be found in [storing plans in a bucket](/howto/store-plans-in-a-bucket)
5+
By default digger will run an apply based on the branch pull request files (no artefacts stored). In order to configure plan artefacts you can configure the inputs for storing as github artefacts or aws buckets or gcp buckets. The corresponding artefacts to be configured can be found in [storing plans in a bucket](/ce/howto/store-plans-in-a-bucket)

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

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,11 @@ name: Digger Workflow
4343
4444
on:
4545
workflow_dispatch:
46-
inputs:
47-
id:
48-
description: 'run identifier'
49-
required: false
50-
job:
51-
required: true
52-
comment_id:
53-
required: true
54-
run_name:
55-
required: false
46+
inputs:
47+
spec:
48+
required: true
49+
run_name:
50+
required: false
5651
5752
run-name: '${{inputs.run_name}}'
5853
@@ -68,14 +63,14 @@ jobs:
6863
6964
steps:
7065
- uses: actions/checkout@v4
71-
- name: ${{github.event.inputs.id}}
72-
run: echo job id ${{ inputs.id }}
66+
- name: ${{ fromJSON(github.event.inputs.spec).job_id }}
67+
run: echo "job id ${{ fromJSON(github.event.inputs.spec).job_id }}"
7368
- uses: diggerhq/digger@vLatest
7469
with:
70+
digger-spec: ${{ inputs.spec }}
7571
setup-aws: true
7672
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
7773
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
78-
disable-locking: true
7974
env:
8075
GITHUB_CONTEXT: ${{ toJson(github) }}
8176
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,7 @@ name: Digger
4343
on:
4444
workflow_dispatch:
4545
inputs:
46-
id:
47-
description: 'run identifier'
48-
required: false
49-
job:
50-
required: true
51-
comment_id:
46+
spec:
5247
required: true
5348
run_name:
5449
required: false
@@ -67,8 +62,8 @@ jobs:
6762
statuses: write # required to validate combined PR status
6863
steps:
6964
- uses: actions/checkout@v4
70-
- name: ${{github.event.inputs.id}}
71-
run: echo job id ${{ inputs.id }}
65+
- name: ${{ fromJSON(github.event.inputs.spec).job_id }}
66+
run: echo "job id ${{ fromJSON(github.event.inputs.spec).job_id }}"
7267
- id: 'auth'
7368
uses: 'google-github-actions/auth@v1'
7469
with:
@@ -81,8 +76,8 @@ jobs:
8176
- name: digger run
8277
uses: diggerhq/digger@vLatest
8378
with:
79+
digger-spec: ${{ inputs.spec }}
8480
setup-aws: false
85-
disable-locking: true
8681
env:
8782
GITHUB_CONTEXT: ${{ toJson(github) }}
8883
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/ce/howto/backendless-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Backendless mode"
55
Digger works best as a 2-piece solution:
66

77
- a CLI that runs inside your CI
8-
- an orchestrator backend that triggers the CI jobs ([GitHub App](https://dashboard.digger.dev) or [self-hosted](/self-host/deploy-docker))
8+
- an orchestrator backend that triggers the CI jobs ([GitHub App](https://dashboard.digger.dev) or [self-hosted](/ce/self-host/deploy-docker))
99

1010
You can however still use the most basic features of Digger as a standalone action without a backend. To do that, set the following option in your workflow configuration:
1111

docs/ce/howto/custom-commands.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Digger makes the following environment variables available to custom commands:
2727
- `$PR_BRANCH`
2828
- `$PROJECT_NAME`
2929

30-
These can be used to achieve workflows like [infracost diff](/howto/using-infracost)
30+
These can be used to achieve workflows like [infracost diff](/ce/howto/using-infracost)
3131

3232
## $DIGGER_OUT
3333

docs/ce/howto/disable-locking.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Disable locking"
3+
---
4+
5+
In order to disable locking repo wide you can add a top-level flag to your digger.yml:
6+
7+
```
8+
pr_locks: false
9+
10+
projects:
11+
- name: dev
12+
dir: dev/
13+
```

docs/ce/howto/multiacc-aws.mdx

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,7 @@ name: Digger Workflow
4949
on:
5050
workflow_dispatch:
5151
inputs:
52-
id:
53-
description: 'run identifier'
54-
required: false
55-
job:
56-
required: true
57-
comment_id:
52+
spec:
5853
required: true
5954
run_name:
6055
required: false
@@ -74,14 +69,14 @@ jobs:
7469
7570
steps:
7671
- uses: actions/checkout@v4
77-
- name: ${{github.event.inputs.id}}
78-
run: echo job id ${{ inputs.id }}
72+
- name: ${{ fromJSON(github.event.inputs.spec).job_id }}
73+
run: echo "job id ${{ fromJSON(github.event.inputs.spec).job_id }}"
7974
- uses: diggerhq/digger@vLatest
8075
with:
76+
digger-spec: ${{ inputs.spec }}
8177
setup-aws: true
8278
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
8379
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
84-
disable-locking: true
8580
env:
8681
GITHUB_CONTEXT: ${{ toJson(github) }}
8782
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/ce/howto/project-level-roles.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ parameter within the workflow file. This role needs to have ability to assume al
3636
If you are not using a aws-role-to-assume setting it workflow you **must** add ```AwsRoleRegion``` property to project level ```aws_role_to_assume```
3737
</Note>
3838

39-
You can also use project-level assume role with [generated projects](/howto/generate-projects):
39+
You can also use project-level assume role with [generated projects](/ce/howto/generate-projects):
4040

4141
```
4242
generate_projects:

docs/ce/howto/using-checkov.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ workflows:
1818
- run: checkov -d . --framework terraform
1919
```
2020

21-
<Note>This docs page needs improvement. Please consider contributing to [docs](https://github.com/diggerhq/docs). Here is the [relevant PR](https://github.com/diggerhq/digger/pull/267) implementing this feature</Note>
21+
<Note>This docs page needs improvement. Please consider contributing to [docs](https://github.com/diggerhq/digger/tree/develop/docs). Here is the [relevant PR](https://github.com/diggerhq/digger/pull/267) implementing this feature</Note>

0 commit comments

Comments
 (0)