Skip to content

Commit e7e2fc1

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

37 files changed

+142
-138
lines changed

docs/ce/azure-specific/azure.mdx

Lines changed: 2 additions & 2 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

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/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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ gcloud iam workload-identity-pools create github-wif-pool --location="global" --
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
```
2121
gcloud iam workload-identity-pools providers create-oidc githubwif \
@@ -27,7 +27,7 @@ gcloud iam workload-identity-pools providers create-oidc githubwif \
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 \
@@ -43,7 +43,7 @@ gcloud iam service-accounts add-iam-policy-binding [email protected]
4343
--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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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/github-actions-+-aws.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Github Actions + AWS"
2+
title: "GitHub Actions + AWS"
33
---
44

5-
In this tutorial, you will set up Digger to automate terraform pull requests using Github Actions and AWS
5+
In this tutorial, you will set up Digger to automate terraform pull requests using GitHub Actions and AWS
66

77
# Prerequisites
88

@@ -34,7 +34,7 @@ projects:
3434
dir: prod
3535
```
3636

37-
# Create Github Actions workflow file
37+
# Create GitHub Actions workflow file
3838

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

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Github Actions + GCP"
2+
title: "GitHub Actions + GCP"
33
---
44

5-
In this tutorial, you will set up Digger to automate terraform pull requests using Github Actions and GCP.
5+
In this tutorial, you will set up Digger to automate terraform pull requests using GitHub Actions and GCP.
66

77
# Prerequisites
88

@@ -33,7 +33,7 @@ projects:
3333
dir: prod
3434
```
3535

36-
# Create Github Actions workflow file
36+
# Create GitHub Actions workflow file
3737

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

@@ -87,7 +87,7 @@ jobs:
8787

8888
This file defines a workflow with 5 steps:
8989

90-
- Checkout repository using Github's official [Checkout action](https://github.com/actions/checkout)
90+
- Checkout repository using GitHub's official [Checkout action](https://github.com/actions/checkout)
9191
- Authenticate into GCP using Google's official [Auth action](https://github.com/google-github-actions/auth). Note the `create_credentials_file: true` option; without it, subsequent steps that rely [Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) will not work.
9292
- Set up Google Cloud SDK for use in the subsequent steps via Google's official [Setup-gcloud action](https://github.com/google-github-actions/setup-gcloud)
9393
- Verify that GCP is configured correctly by running `gcloud info`

docs/ce/getting-started/gitlab-pipelines-+-aws.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ title: "GitLab Pipelines + AWS"
1111

1212
### Configuring and Deploying AWS Lambda: Step-by-Step Guide
1313

14-
1. Fork and clone this repo: [https://github.com/diggerhq/gitlab-webhook-lambda](https://github.com/diggerhq/gitlab-webhook-lambda).
14+
1. Fork and clone this repo: [https://github.com/diggerhq/GitLab-webhook-lambda](https://github.com/diggerhq/GitLab-webhook-lambda).
1515

1616
2. If necessary, update the `serverless.yml` file in the cloned repository. This file contains configuration settings for the Lambda function and can be customized to suit your requirements.
1717

18-
3. Save the `GITLAB_TOKEN`to the SSM (Systems Manager) parameter store. You can choose any path for storing the token, but ensure that the `serverless.yml` file is updated accordingly if you deviate from the default path. For example, save the `GITLAB_TOKEN`to `ssm:/gitlab-dev-webhook-handler/dev/GITLAB_TOKEN`.
18+
3. Save the `GITLAB_TOKEN`to the SSM (Systems Manager) parameter store. You can choose any path for storing the token, but ensure that the `serverless.yml` file is updated accordingly if you deviate from the default path. For example, save the `GITLAB_TOKEN`to `ssm:/GitLab-dev-webhook-handler/dev/GITLAB_TOKEN`.
1919

20-
4. Do the same for SECRET\_TOKEN, update serverless.yml if needed and save token value to ssm parameter (for example `ssm:/gitlab-dev-webhook-handler/dev/SECRET_TOKEN`)
20+
4. Do the same for SECRET\_TOKEN, update serverless.yml if needed and save token value to ssm parameter (for example `ssm:/GitLab-dev-webhook-handler/dev/SECRET_TOKEN`)
2121

2222
5. Make sure that your AWS credentials are properly configured in the command-line interface (CLI). This ensures that you have the necessary permissions to deploy the Lambda function.
2323

0 commit comments

Comments
 (0)