Skip to content

Commit 56810cd

Browse files
committed
fix GitHub and GitLab spelling to a correct one
Signed-off-by: George Gaál <[email protected]>
1 parent 5cf11a5 commit 56810cd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+236
-236
lines changed

docs/ce/azure-specific/azure.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Click "Go to Resource"; go to Access keys (on the lefthand side)
1414

1515
Click "show" on the connection string. Copy and save it securely; it will be needed later in this guide.
1616

17-
## 2\. Add Azure keys to Github Actions Secrets
17+
## 2\. Add Azure keys to GitHub Actions Secrets
1818

1919
### In Azure
2020

@@ -32,7 +32,7 @@ Go to Certificates and Secrets. Click New Client Secret. Give it a name; click A
3232

3333
Go to **subscription** in the portal and select your subscription ID, select **Access Control (IAM)** and **Add** the **Role assignment**, **Contributor** to your Service Principal. Take note of your Subscription ID value
3434

35-
### In Github
35+
### In GitHub
3636

3737
- Go to Settings → Secrets and Variables
3838

@@ -73,7 +73,7 @@ on:
7373
types: [ closed, opened, synchronize, reopened ]
7474
issue_comment:
7575
types: [created]
76-
if: contains(github.event.comment.body, 'digger')
76+
if: contains(GitHub.event.comment.body, 'digger')
7777
workflow_dispatch:
7878
7979
jobs:
@@ -87,16 +87,16 @@ jobs:
8787
env:
8888
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8989
run: |
90-
PR_URL="${{ github.event.issue.pull_request.url }}"
90+
PR_URL="${{ GitHub.event.issue.pull_request.url }}"
9191
PR_NUM=${PR_URL}
9292
echo "Checking out from PR #$PR_NUM based on URL: $PR_URL"
9393
hub pr checkout $PR_NUM
94-
if: github.event_name == 'issue_comment'
94+
if: GitHub.event_name == 'issue_comment'
9595
9696
- name: digger
9797
uses: diggerhq/digger@vLatest
9898
env:
99-
GITHUB_CONTEXT: ${{ toJson(github) }}
99+
GITHUB_CONTEXT: ${{ toJson(GitHub) }}
100100
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
101101
LOCK_PROVIDER: azure
102102
DIGGER_AZURE_AUTH_METHOD: CONNECTION_STRING

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ jobs:
3636
**aws-role-to-assume: arn:aws:iam::{AccountID}:role/{RoleName}**
3737
aws-region: us-east-1
3838
env:
39-
GITHUB_CONTEXT: ${{ toJson(github) }}
39+
GITHUB_CONTEXT: ${{ toJson(GitHub) }}
4040
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4141
```

docs/ce/features/opa-policies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ With plan policies you can check `terraform plan` output for compliance with you
1717

1818
With access policies you can control which Digger operations are allowed at any given time based on various inputs. Access policy is checked before every plan and apply and is passed the following data:
1919

20-
- user id (from github)
20+
- user id (from GitHub)
2121
- plan policy violations, if any
2222
- list of users who approved the PR
2323

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](/ce/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/features/plan-preview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ You can also re-plan by commenting `digger plan` (see [CommentOps](/features/com
1717

1818
* By performing locks on pull request we guarantee that the plan preview on the pull request is not stale. i.e. the infrastructure was not touched by another subsequent change
1919

20-
* Code in github: [https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/digger/digger.go#L228](https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/digger/digger.go#L228)
20+
* Code in GitHub: [https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/digger/digger.go#L228](https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/digger/digger.go#L228)

docs/ce/features/pr-level-locks.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ title: "PR-level locks"
44

55
* For every pull request we perform a lock when the pull request is opened and unlocked when the pull request is merged, this is to avoid making a plan preview stale
66

7-
* For GCP locking is performed using buckets that are strongly consistent: [https://github.com/diggerhq/digger/blob/80289922227f225d887feb74749b4daef8b441f8/pkg/gcp/gcp\_lock.go#L13](https://github.com/diggerhq/digger/blob/80289922227f225d887feb74749b4daef8b441f8/pkg/gcp/gcp%5Flock.go#L13)
7+
* For GCP locking is performed using buckets that are strongly consistent: [https://GitHub.com/diggerhq/digger/blob/80289922227f225d887feb74749b4daef8b441f8/pkg/gcp/gcp\_lock.go#L13](https://GitHub.com/diggerhq/digger/blob/80289922227f225d887feb74749b4daef8b441f8/pkg/gcp/gcp%5Flock.go#L13)
88

99
* These options are configured and the locking can be disabled entirely if it is not needed
1010

11-
* The locking interface is very simple and is based on `Lock()` and `Unlock()` Operations [https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/locking/locking.go#L40](https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/locking/locking.go#L40)
11+
* The locking interface is very simple and is based on `Lock()` and `Unlock()` Operations [https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/locking/locking.go#L40](https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/locking/locking.go#L40)
1212

1313
* A pull request acquires a lock for every project impacted by this PR and all dependant projects

docs/ce/features/private-runners.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Private Runners"
44

55
In many situations you wish to run digger with private runners. For example if you are provisioning resources in a private k8s cluster in this case you will not be able to use cloud runners.
66

7-
While digger does not natively support k8s agents it is very easy to do it indirectly using github actions runners.
7+
While digger does not natively support k8s agents it is very easy to do it indirectly using GitHub actions runners.
88
In the typical digger flow you are using a workflow that looks like this:
99

1010
```
@@ -16,8 +16,8 @@ jobs:
1616
runs-on: ubuntu-latest
1717
```
1818

19-
With github specifically there is good support for [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)
20-
which means that you can create agents for github actions in your private infrastructure's VPC and github will then run the jobs there.
19+
With GitHub specifically there is good support for [self-hosted runners](https://docs.GitHub.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)
20+
which means that you can create agents for GitHub actions in your private infrastructure's VPC and GitHub will then run the jobs there.
2121

2222
The easiest way to achieve self-hosted runners is by running the agent in something like an EC2 instance. Alternatively if you already have a kubernetes cluster
2323
you could opt for using the [Actions runner controller](which will provide you with actions right in your cluster). Once you have set up and configured your controllers

docs/ce/gcp/federated-oidc-access.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ If you already have configured GCP for that, skip to step 5.
1010
A Workload Identity Pool is an umbrella entity for managing access in GCP. The best practice is to have a dedicated pool for each non-GCP environment.
1111

1212
```
13-
gcloud iam workload-identity-pools create github-wif-pool --location="global" --project
13+
gcloud iam workload-identity-pools create GitHub-wif-pool --location="global" --project
1414
```
1515

1616
## 2\. Create a Workload Identity Provider
1717

18-
A Workload Identity Provider links an external identity like Github with your Google Cloud account. This lets IAM use tokens from external providers to authorize access to Google Cloud resources.
18+
A Workload Identity Provider links an external identity like GitHub with your Google Cloud account. This lets IAM use tokens from external providers to authorize access to Google Cloud resources.
1919

2020
```
21-
gcloud iam workload-identity-pools providers create-oidc githubwif \
22-
--location="global" --workload-identity-pool="github-wif-pool" \
23-
--issuer-uri="https://token.actions.githubusercontent.com" \
21+
gcloud iam workload-identity-pools providers create-oidc GitHubwif \
22+
--location="global" --workload-identity-pool="GitHub-wif-pool" \
23+
--issuer-uri="https://token.actions.GitHubusercontent.com" \
2424
--attribute-mapping="attribute.actor=assertion.actor,google.subject=assertion.sub,attribute.repository=assertion.repository" \
2525
--project
2626
```
2727

2828
## 3\. Create a Service Account and bind policies
2929

30-
A service account with relevant permissions will be impersonated by WIF. This allows Github action to impersonate the service account and get a token.
30+
A service account with relevant permissions will be impersonated by WIF. This allows GitHub action to impersonate the service account and get a token.
3131

3232
```
3333
gcloud iam service-accounts create test-wif \
@@ -40,10 +40,10 @@ gcloud projects add-iam-policy-binding \
4040
gcloud iam service-accounts add-iam-policy-binding [email protected] \
4141
--project= \
4242
--role="roles/iam.workloadIdentityUser" \
43-
--member="principalSet://iam.googleapis.com/projects//locations/global/workloadIdentityPools/github-wif-pool/attribute.repository/PradeepSingh1988/gcp-wif"
43+
--member="principalSet://iam.googleapis.com/projects//locations/global/workloadIdentityPools/GitHub-wif-pool/attribute.repository/PradeepSingh1988/gcp-wif"
4444
```
4545

46-
## 4\. Add secrets to Github
46+
## 4\. Add secrets to GitHub
4747

4848
Create 2 secrets in your Action Secrets with the following names:
4949

@@ -53,19 +53,19 @@ Create 2 secrets in your Action Secrets with the following names:
5353

5454
## 5\. Configure Digger workflow to use federated access
5555

56-
Set `EXT` env var instead of the usual key pair. See [oidc-gcp-example](https://github.com/diggerhq/digger-gcp-ocid-demo) repo for more detail. Sample config below:
56+
Set `EXT` env var instead of the usual key pair. See [oidc-gcp-example](https://GitHub.com/diggerhq/digger-gcp-ocid-demo) repo for more detail. Sample config below:
5757

5858
```
5959
- id: 'auth'
60-
uses: 'google-github-actions/auth@v1'
60+
uses: 'google-GitHub-actions/auth@v1'
6161
with:
6262
token_format: access_token
6363
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
6464
service_account: ${{ env.GCP_SERVICE_ACCOUNT }}
6565
audience: google-wif
6666
6767
- name: 'Set up Cloud SDK'
68-
uses: 'google-github-actions/setup-gcloud@v1'
68+
uses: 'google-GitHub-actions/setup-gcloud@v1'
6969
7070
- name: 'Use gcloud CLI'
7171
run: |
@@ -75,7 +75,7 @@ Set `EXT` env var instead of the usual key pair. See [oidc-gcp-example](https://
7575
uses: diggerhq/digger@vLatest
7676
env:
7777
LOCK_PROVIDER: gcp
78-
GITHUB_CONTEXT: ${{ toJson(github) }}
78+
GITHUB_CONTEXT: ${{ toJson(GitHub) }}
7979
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8080
GOOGLE_STORAGE_BUCKET: digger-lock2
8181
@@ -85,7 +85,7 @@ Set `EXT` env var instead of the usual key pair. See [oidc-gcp-example](https://
8585

8686
<Note>
8787
This article is based on [this
88-
post](https://medium.com/google-cloud/how-does-the-gcp-workload-identity-federation-work-with-github-provider-a9397efd7158)
88+
post](https://medium.com/google-cloud/how-does-the-gcp-workload-identity-federation-work-with-GitHub-provider-a9397efd7158)
8989
by Pradeep Kumar Singh
9090
</Note>
9191
```

docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ title: "Setting up GCP + GH Actions"
44

55

66

7-
In this tutorial we will be using a repository in order to configure a terraform pipeline [https://github.com/diggerhq/digger-gcp-lock-demo](https://github.com/diggerhq/digger-gcp-lock-demo). In order to use GCP with Digger we follow the steps below:
7+
In this tutorial we will be using a repository in order to configure a terraform pipeline [https://GitHub.com/diggerhq/digger-gcp-lock-demo](https://GitHub.com/diggerhq/digger-gcp-lock-demo). In order to use GCP with Digger we follow the steps below:
88

99

1010
Let's create our first pull request with a change and see this in action:
1111

12-
1. Fork the [demo repository](https://github.com/diggerhq/digger-gcp-lock-demo)
12+
1. Fork the [demo repository](https://GitHub.com/diggerhq/digger-gcp-lock-demo)
1313

1414
2. Enable Actions (by default workflows won't trigger in a fork)
1515

@@ -19,7 +19,7 @@ Let's create our first pull request with a change and see this in action:
1919

2020
![](images/configuration/2.webp)
2121

22-
4. Add environment variables into your Github Action Secrets (cloud keys are a requirement since digger needs to connect to your account for coordinating locks). Use[ this guide](https://developers.google.com/workspace/guides/create-credentials) to get the value for it:
22+
4. Add environment variables into your GitHub Action Secrets (cloud keys are a requirement since digger needs to connect to your account for coordinating locks). Use[ this guide](https://developers.google.com/workspace/guides/create-credentials) to get the value for it:
2323

2424
![](/images/gcp/1.png)
2525

docs/ce/getting-started/azure-devops.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For tutorial purposes the token is shown with full access. Don't do that in prod
3838

3939
## 2\. Set up Azure Function
4040

41-
Clone [this repository](https://github.com/diggerhq/azure-devops-webhook-handler), then follow [this guide](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-python?pivots=python-mode-configuration) deploy the function to your azure account
41+
Clone [this repository](https://GitHub.com/diggerhq/azure-devops-webhook-handler), then follow [this guide](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-python?pivots=python-mode-configuration) deploy the function to your azure account
4242

4343
![](/images/getting-started/azure-devops-3.png)
4444

@@ -71,7 +71,7 @@ Select the repository you want to integrate digger with. Add the following 4 eve
7171

7272
## 4\. Create digger.yml
7373

74-
Follow the digger documentation to create digger.yml for your structure, it should be similar to this [demo digger.yml](https://github.com/diggerhq/digger%5Fdemo%5Fmultienv/blob/main/digger.yml)
74+
Follow the digger documentation to create digger.yml for your structure, it should be similar to this [demo digger.yml](https://GitHub.com/diggerhq/digger%5Fdemo%5Fmultienv/blob/main/digger.yml)
7575

7676
The minimum you would need to define for digger is where all your terraform lives:
7777

0 commit comments

Comments
 (0)