fix GitHub and GitLab spelling to a correct one #2008
Conversation
WalkthroughThis change standardizes the capitalization of brand names, primarily "GitHub" and "GitLab," across a wide range of documentation and configuration files. It also corrects some URLs, file names, and example values to match the proper casing. No functional, logical, or instructional changes were made; all updates are textual and stylistic. Changes
Sequence Diagram(s)No sequence diagram generated due to the purely textual and stylistic nature of the changes. Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Comprehensive brand name standardization across documentation files, ensuring correct capitalization of 'GitHub' and 'GitLab' platform names according to official branding guidelines.
- Fixed inconsistent capitalization of 'GitLab CI' in
docs/readme/introduction.mdxand 'GitLab' instances across multiple files - Corrected 'Github' to 'GitHub' in integration docs like
docs/ee/buildkite.mdxanddocs/ce/gcp/setting-up-gcp-+-gh-actions.mdx - Several files still contain missed instances of incorrect capitalization (e.g., 'GiHub' typo in
docs/ce/getting-started/github-actions-and-gcp.mdx) - Documentation indentation issues found in GitHub Actions workflow YAML on line 78 of
docs/ce/getting-started/github-actions-and-gcp.mdx
20 files reviewed, 7 comments
Edit PR Review Bot Settings | Greptile
gecube
force-pushed
the
github-gitlab-naming
branch
2 times, most recently
from
ba39195 to
56810cd
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 19
🔭 Outside diff range comments (4)
docs/ce/getting-started/github-actions-and-gcp.mdx (1)
66-84:${{ GitHub… }}will break the workflow – revert to lowercasegithub.
githubis the only valid built-in context object in GitHub Actions expressions (case-sensitive).
UsingGitHubwill cause the workflow run to fail with the error “Unrecognized named reference”.- - name: ${{ fromJSON(GitHub.event.inputs.spec).job_id }} - run: echo "job id ${{ fromJSON(GitHub.event.inputs.spec).job_id }}" - - id: 'auth' - uses: 'google-GitHub-actions/auth@v1' + - name: ${{ fromJSON(github.event.inputs.spec).job_id }} + run: echo "job id ${{ fromJSON(github.event.inputs.spec).job_id }}" + - id: auth + uses: 'google-github-actions/auth@v1' @@ - uses: 'google-GitHub-actions/setup-gcloud@v1' + uses: 'google-github-actions/setup-gcloud@v1' @@ - GITHUB_CONTEXT: ${{ toJson(GitHub) }} + GITHUB_CONTEXT: ${{ toJson(github) }}Same applies to every other occurrence in the file.
Please revert; otherwise the sample users will copy-paste a non-working workflow.docs/ce/getting-started/github-actions-+-aws.mdx (1)
68-78: Upper-caseGitHubcontext & action slugs will fail – switch back to canonical forms.Same issue as in the GCP guide: expressions must use
github, and the action repo isgoogle-github-actions/*.- - name: ${{ fromJSON(GitHub.event.inputs.spec).job_id }} + - name: ${{ fromJSON(github.event.inputs.spec).job_id }} @@ - GITHUB_CONTEXT: ${{ toJson(GitHub) }} + GITHUB_CONTEXT: ${{ toJson(github) }}Please fix all occurrences.
docs/ce/gcp/federated-oidc-access.mdx (1)
56-79: InvalidGitHubcontext object in workflow snippet.Update the snippet to use the correct lowercase identifiers and action slugs.
- uses: 'google-GitHub-actions/auth@v1' + uses: 'google-github-actions/auth@v1' @@ - uses: 'google-GitHub-actions/setup-gcloud@v1' + uses: 'google-github-actions/setup-gcloud@v1' @@ - GITHUB_CONTEXT: ${{ toJson(GitHub) }} + GITHUB_CONTEXT: ${{ toJson(github) }}docs/ce/self-host/self-host-on-azure.mdx (1)
136-182: Workflow path and context object casing are incorrect.
- GitHub only recognises
.github/workflows/…(all lowercase) for workflow discovery.- Expressions must use
github, notGitHub.-create this GitHub workflow in your repository under `.GitHub/workflow/digger_workflow.yml` +Create this GitHub workflow under `.github/workflows/digger_workflow.yml` @@ - - name: ${{ fromJSON(GitHub.event.inputs.spec).job_id }} + - name: ${{ fromJSON(github.event.inputs.spec).job_id }} @@ - GITHUB_CONTEXT: ${{ toJson(GitHub) }} + GITHUB_CONTEXT: ${{ toJson(github) }}Without these fixes, readers will get a broken CI setup.
♻️ Duplicate comments (1)
docs/ee/gitlab-support.mdx (1)
54-56: Filename case issue identical to the other GitLab docUse
.gitlab-ci.yml, not.GitLab-ci.yml, to avoid confusion.
🧹 Nitpick comments (55)
docs/ce/howto/workspaces.mdx (1)
24-24: Prefer canonical lowercase for domain part of URLsDomains are case-insensitive, but mixed-case hostnames can look odd and break some tooling that relies on simple string matching. Consider keeping the link text branded while leaving the URL all-lowercase.
-Example repository: [https://GitHub.com/diggerhq/digger_demo_workspaces/](https://GitHub.com/diggerhq/digger%5Fdemo%5Fworkspaces/) +Example repository: [https://github.com/diggerhq/digger_demo_workspaces/](https://github.com/diggerhq/digger%5Fdemo%5Fworkspaces/)docs/ce/howto/using-checkov.mdx (1)
21-21: URL domain casing nitpickSame remark as above—lower-casing the
github.compart keeps links uniform and avoids confusing diffs later.-<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> +<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>docs/ce/howto/managing-state.mdx (1)
13-13: Lowercase hostname for readabilityRecommend the same lowercase domain tweak for consistency.
-The example repo for this is here: https://GitHub.com/diggerhq/states-test +The example repo for this is here: https://github.com/diggerhq/states-testdocs/ce/howto/apply-on-merge.mdx (1)
23-23: Grammar + URL casingCapitalize the sentence start, add the missing comma after the introductory phrase, and unify the link host casing.
- right now there is no way to prevent running `apply` via comment, even if apply on merge is configured. Tracked in [#272](https://GitHub.com/diggerhq/digger/issues/272) + Right now, there is no way to prevent running `apply` via comment, even if apply on merge is configured. Tracked in [#272](https://github.com/diggerhq/digger/issues/272)docs/ce/howto/using-terragrunt.mdx (2)
12-12: Minor URL-style nit: consider keeping hostnames lowercaseDomain names are case-insensitive and are conventionally written in lowercase. Using mixed-case (e.g.
GitHub.com) is perfectly valid but can look visually inconsistent across docs and snippets.No action required if branding consistency is preferred, just flagging for consideration.
32-32: Same hostname-casing remark as aboveSee earlier comment on line 12.
docs/ce/features/plan-persistence.mdx (1)
5-5: Tighten wording and fix article misuseThe phrase “run an apply” reads awkwardly, and “In order to” can be simplified.
Proposed edit:-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. +By default, Digger runs `apply` directly against the files in the pull-request branch (no artefacts stored). To store plan artefacts, configure the inputs for GitHub artefacts, AWS buckets, or GCP buckets.docs/ee/fips-140.mdx (3)
7-7: Spelling & punctuation
seperately→separately; add a comma after the introductory clause.-as of version v0.6.101 digger backend and cli are both compiled seperately with FIPS140 enabled. +As of version v0.6.101, Digger backend and CLI are both compiled separately with FIPS-140 enabled.
7-7: Streamline phrasingReplace “In order to enable it for GitHub follow these steps:” with a simpler form.
-In order to enable it for GitHub follow these steps: +To enable it for GitHub, follow these steps:
19-19: Consistency: VCS acronym casingConsider replacing “If you are using GitLab or other VCS then” with a comma after the conditional clause for readability.
-If you are using GitLab or other VCS then just ensure that you are downloading the fips enabled binary which is suffixed with '_fips' +If you are using GitLab or another VCS, just ensure that you download the FIPS-enabled binary suffixed with `_fips`.docs/ce/features/plan-preview.mdx (1)
20-20: Hostname-case nitSame note as earlier:
GitHub.comis valid but unconventional; decide on a single style across docs (github.comis most common).docs/readme/faq.mdx (1)
8-8: Lower-case domain suggestionConsider keeping the URL host in lowercase for consistency (
github.com). No functional impact.docs/ce/self-host/auth-methods.mdx (1)
10-12: Add missing comma after the introductory phrase.Grammar nit: insert a comma after “As of Jan 2024” to separate the introductory time expression from the main clause.
-Auth via JWT token, same as used in Digger Cloud. As of Jan 2024 the only supported JWT auth provider is ... +Auth via JWT token, same as used in Digger Cloud. As of Jan 2024, the only supported JWT auth provider is ...docs/ce/howto/auto-merge.mdx (1)
17-18: Insert a comma for readability.A comma after “GitHub VCS” improves clarity of the dependent clause.
-If you are using GitHub VCS you can also specify +If you are using GitHub VCS, you can also specifydocs/ee/rbac.mdx (1)
19-19: Prefer lowercase hostnames in URLsDomain names are case-insensitive, but the convention (and the rest of the docs) uses
github.com. Switching toGitHub.comlooks odd and may confuse copy-pasted CLI snippets that rely on exact string matching.-This way you can implement advanced workflows such as [policy overrides](https://GitHub.com/diggerhq/demo-policy-overrides/pull/9) based on roles and granular permissions. +This way you can implement advanced workflows such as [policy overrides](https://github.com/diggerhq/demo-policy-overrides/pull/9) based on roles and granular permissions.docs/ce/features/pr-level-locks.mdx (2)
7-7: Tighten wording & keep hostname lowercaseMinor readability/consistency tweaks:
-* 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) +* For GCP, locking is performed with strongly consistent buckets: [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)
11-11: Grammar & casingSame style/grammar issue as above:
-* 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) +* The locking interface is 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)docs/ce/troubleshooting/action-errors.mdx (1)
11-11: Keep hostname lowercase for consistencySame note as earlier; lowercase hostnames are conventional and used elsewhere:
-- starting from [v0.4.14](https://GitHub.com/diggerhq/digger/releases/tag/v0.4.14) Digger no longer requires a token (a temporary one is generated instead). Check that you are using the latest version of BOTH cli in the workflow and the orchestrator. +- starting from [v0.4.14](https://github.com/diggerhq/digger/releases/tag/v0.4.14) Digger no longer requires a token (a temporary one is generated instead). Check that you are using the latest version of BOTH cli in the workflow and the orchestrator.docs/ce/howto/commenting-strategies.mdx (2)
5-5: Fix typo and hostname-* The way digger comments plan previews on PRs can be configured based on the requirement of verbosity or summary. The value of the summary can be configured using the `reporting-strategy` parameter: [https://GitHub.com/diggerhq/digger/blob/develop/action.yml#L105](https://GitHub.com/diggerhq/digger/blob/develop/action.yml#L105) +* The way Digger posts plan previews on PRs can be configured for verbosity or brevity. Set the desired behaviour via the `reporting-strategy` parameter: [https://github.com/diggerhq/digger/blob/develop/action.yml#L105](https://github.com/diggerhq/digger/blob/develop/action.yml#L105)
11-11: Minor wording & hostname-* More details about the reporting strategy can be seen in the reporter interface: [https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/reporting/reporting.go#L12](https://GitHub.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/reporting/reporting.go#L12) +* More details about the reporting strategy are in the reporter interface: [https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/reporting/reporting.go#L12](https://github.com/diggerhq/digger/blob/5815775095d7380281c71c7c3aa63ca1b374365f/pkg/reporting/reporting.go#L12)docs/ce/howto/store-plans-in-a-bucket.mdx (1)
5-7: Minor wording/grammar nitpickSentence can be shorter and needs a comma after the introductory clause.
-Digger can use GitHub Artifacts to store `terraform plan` outputs. In order to enable it you can set the following argument in digger_workflow.yml: +Digger can use GitHub Artifacts to store `terraform plan` outputs. To enable it, set the following argument in `digger_workflow.yml`:docs/ce/howto/disable-telemetry.mdx (1)
5-6: URL casing is unconventionalDomain names are case-insensitive but almost always written in lowercase. Lower-case keeps links tidy and avoids surprising readers.
-[usage.go](https://GitHub.com/diggerhq/digger/blob/develop/cli/pkg/usage/usage.go) +[usage.go](https://github.com/diggerhq/digger/blob/develop/cli/pkg/usage/usage.go)docs/ce/howto/apply-requirements.mdx (1)
5-6: Consider reverting URL casing for consistencyUsing
GitHub.comworks, but the project’s docs overwhelmingly use lowercasegithub.com. Staying consistent avoids diff churn in future edits.No functional impact – optional update only.
Also applies to: 12-13
docs/ce/reference/action-inputs.mdx (1)
5-5: Link still resolves, but watch for mixed-case domains in automated toolingSame note as above – capitalising the domain won’t break the link but can confuse certain markdown or link-checker linters. If repo policy now requires “GitHub.com”, ignore this.
docs/ce/self-host/deploy-docker-compose.mdx (2)
57-57: Environment-variable value casing is harmless but inconsistent
your_GitHub_orgmixes snake-case with brand casing. If the value is only a placeholder, consideryour_github_orgto keep examples visually consistent.
94-94: Grammar nit: “its” vs “it's”“From here on it's the same steps …”
Should be “its”.-From here on it's the same steps as in the [Quickstart] +From here on its the same steps as in the [Quickstart]docs/ce/securing-digger/external-provider.mdx (2)
5-5: Spelling: “privileged”-Digger executes terraform in GitHub actions within previlliged environments. +Digger executes Terraform in GitHub Actions within privileged environments.
13-14: Grammar: use “it’s” → “it is / it’s” and comma clarityConsider:
-Secondly its important to ensure that only trusted individuals are allowed to update the terraform code. +Secondly, it’s important to ensure that only trusted individuals are allowed to update the Terraform code.Also add a comma after “discussion” for readability.
docs/mint.json (1)
18-19: Domain names are case-insensitive, but URLs conventionally stay lowercase.Changing
https://github.com/...tohttps://GitHub.com/...is technically valid yet unconventional and may look odd in rendered HTML. Consider reverting to the common lowercase style for readability and to avoid diffs churn.Purely stylistic – up to you.
docs/ee/buildkite.mdx (1)
18-19: Upper-casing the domain in Docker image URL is harmless but noisy.Docker registries and browsers treat hostnames case-insensitively. Keeping
https://github.com/...is the conventional style and avoids unnecessary churn in future diffs.Feel free to keep as-is if branding consistency is a hard requirement.
docs/ce/howto/generate-projects.mdx (1)
40-41: Unusual capitalisation in link URL.
https://GitHub.com/diggerhq/generate_projects_demoworks, but using lowercase hostnames is standard practice and keeps diff noise low.
Suggested (optional):-[Demo repo](https://GitHub.com/diggerhq/generate_projects_demo) +[Demo repo](https://github.com/diggerhq/generate_projects_demo)docs/readme/feedback.mdx (2)
9-9: Avoid capitalising the domain part of the URL.Changing
github.com→GitHub.comis cosmetically nice but unconventional. Domain names are case-insensitive, yet most docs (including GitHub’s own) keep them lowercase; sticking to the canonical form avoids confusing diff churn later.No action required if you prefer the branding change—just flagging the trade-off.
13-15: Fix typo and verb agreement in bullet #1.-1. Terraform file for the initial condiguration to setup S3 bucket and dynamo DB for [state management](https://GitHub.com/diggerhq/digger/issues/206). +1. Terraform file for the initial configuration that sets up an S3 bucket and DynamoDB table for [state management](https://GitHub.com/diggerhq/digger/issues/206).This removes the misspelling “condiguration”, adds the missing article, and aligns verb tense.
docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx (2)
7-8: Minor style: tighten sentence and add comma.-In this tutorial we will be using a repository in order to configure a terraform pipeline +In this tutorial, we will use a repository to configure a Terraform pipelineRemoves two verbose “in order to” occurrences and inserts a comma after the introductory clause.
22-23: Insert missing space after “Use”.-Add environment variables into your GitHub Action Secrets ... Use[ this guide] +Add environment variables into your GitHub Action Secrets ... Use [this guide]Pure readability tweak.
docs/ee/ee-setup.mdx (2)
15-16: Add comma for readability.-By the end of this you should have your orchestrator up and running internally, +By the end of this, you should have your orchestrator up and running internally,
19-22: Tighten wording and add commas.-After you have the orchestrator up and running you will need a repo to test digger on. +After the orchestrator is running, you will need a repo to test Digger on. ... -Once you have the repo ready you need to install it to the image. +Once the repo is ready, install it in the image.Pure stylistic polish; adjust if preferred.
docs/readme/pricing.mdx (1)
44-47: Tighten phrasing & flow in the FAQ answerThe sentence is a bit verbose and the word order is awkward. A lighter formulation improves readability:
-All of Digger is open source, even the enterprise edition. The feature set of Digger cloud (GitHub App) and Digger community edition is exactly the same, the difference is only where it is hosted. Please note that Digger Cloud is GitHub Only, for Bitbucket & GitLab you'd have to Self Manage it, unless you want a dedicated instance under an enterprise license. +All of Digger is open-source, including the enterprise edition. The feature set of Digger Cloud (GitHub App) and Digger Community Edition is identical; the only difference is where it is hosted. Note that Digger Cloud supports GitHub only — for Bitbucket or GitLab you’ll need to self-manage or request a dedicated enterprise instance.docs/ce/reference/digger.yml.mdx (2)
105-105: Minor grammar tweakAdd the missing verb to keep the note clear:
- currently only GitHub supported for this flag + currently only GitHub is supported for this flag
170-172: Comma + article missing in explanatory note- this can be used for secrets. For example you set a secret from some secret manager (e.g. GitHub secrets) as environment variable and the remap it to another variable. + This can be used for secrets. For example, you set a secret from some secret manager (e.g. GitHub Secrets) as an environment variable, and then remap it to another variable.docs/ee/multi-github.mdx (2)
6-8: Plural & commas for smoother reading-In larger orgs there could be a requirement that there are multiple orgs representing department. +In larger organisations, there may be multiple orgs representing different departments.
35-35: Use the correct contraction-**Important**: its important to install using the link in the table +**Important**: it’s important to install using the link in the tabledocs/ce/features/private-runners.mdx (2)
7-7: Grammar & readability tweakAdd a comma after the introductory clause and drop the weak “very”:
-While digger does not natively support k8s agents it is very easy to do it indirectly using GitHub actions runners. +While Digger does not natively support k8s agents, it is easy to do it indirectly using GitHub Actions runners.
19-20: Keep URL casing conventional
https://docs.github.com/...is the canonical form used by GitHub’s own docs.
Capitalising the domain adds visual noise without benefit.-[self-hosted runners](https://docs.GitHub.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners) +[self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners)docs/ce/self-host/deploy-docker.mdx (2)
10-10: Revert capitalisation inside external linkGitHub’s pages and redirects tolerate case but the project URL is normally shown
in all-lowercase. Keeping the canonical form avoids surprises when users copy
& paste.-[repo on GitHub](https://GitHub.com/diggerhq/digger) +[repo on GitHub](https://github.com/diggerhq/digger)
66-66: Fix “it’s” vs “its”-From here on it's the same steps as in the [Quickstart](/ce/getting-started/GitHub-actions-+-aws): +From here on its steps are the same as in the [Quickstart](/ce/getting-started/github-actions-+-aws):docs/team/getting-started/gha-aws.mdx (1)
7-7: Canonical link casingSame remark as elsewhere – consider keeping
https://github.com/...to match the
actual URL.docs/ce/self-host/deploy-binary.mdx (1)
28-29: Missing preposition – quick readability fix-...not to be confused the CLI agent that runs in the CI job. +...not to be confused **with** the CLI agent that runs in the CI job.docs/ce/howto/project-level-roles.mdx (1)
46-47: Typo: ‘alot’ → ‘a lot’-The GitHub action JWT token includes alot of useful fields +The GitHub Action JWT token includes a lot of useful fieldsdocs/ce/getting-started/github-actions-and-gcp.mdx (2)
16-16: Still spelled “GiHub”.You missed one instance:
GiHub→GitHub.
91-92: Grammar: “rely on Application Default Credentials”.-steps that rely [Application Default Credentials] +steps that rely on [Application Default Credentials]docs/ce/getting-started/github-actions-+-aws.mdx (1)
16-16: Typo:GiHub→GitHub.docs/ce/gcp/federated-oidc-access.mdx (1)
30-30: Article grammar: “GitHub Action” → “GitHub Actions workflow” (plural brand name).docs/ce/self-host/self-host-on-azure.mdx (1)
5-10: Run-on sentence & capitalisation.The introductory sentence is long and mixes cases (“azure”, “GitHub”). Consider:
“This guide shows how to deploy the Digger orchestrator on Azure and configure your GitHub Actions workflow to trigger it.”
docs/readme/introduction.mdx (1)
30-34: Tidy up remaining CI brand names and pluralisationWhile you’re touching this paragraph, consider the following minor tweaks for accuracy and style:
Official names:
• “Circle CI” → “CircleCI”
• “Azure DevOps” is fine, but some docs append “Pipelines”.Plural: “other CI's” → “other CIs” (apostrophe is possessive).
These are purely editorial and optional.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (59)
docs/ce/azure-specific/azure.mdx(4 hunks)docs/ce/cloud-providers/authenticating-with-oidc-on-aws.mdx(1 hunks)docs/ce/features/opa-policies.mdx(1 hunks)docs/ce/features/plan-persistence.mdx(1 hunks)docs/ce/features/plan-preview.mdx(1 hunks)docs/ce/features/pr-level-locks.mdx(1 hunks)docs/ce/features/private-runners.mdx(2 hunks)docs/ce/gcp/federated-oidc-access.mdx(5 hunks)docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx(2 hunks)docs/ce/getting-started/azure-devops.mdx(2 hunks)docs/ce/getting-started/github-actions-+-aws.mdx(4 hunks)docs/ce/getting-started/github-actions-and-gcp.mdx(4 hunks)docs/ce/getting-started/gitlab-pipelines-+-aws.mdx(1 hunks)docs/ce/howto/apply-on-merge.mdx(1 hunks)docs/ce/howto/apply-requirements.mdx(1 hunks)docs/ce/howto/auto-merge.mdx(1 hunks)docs/ce/howto/backendless-mode.mdx(1 hunks)docs/ce/howto/commenting-strategies.mdx(1 hunks)docs/ce/howto/destroy-manual.mdx(1 hunks)docs/ce/howto/disable-telemetry.mdx(1 hunks)docs/ce/howto/generate-projects.mdx(2 hunks)docs/ce/howto/managing-state.mdx(1 hunks)docs/ce/howto/multiacc-aws.mdx(2 hunks)docs/ce/howto/project-level-roles.mdx(3 hunks)docs/ce/howto/specify-terraform-version.mdx(2 hunks)docs/ce/howto/store-plans-in-a-bucket.mdx(1 hunks)docs/ce/howto/trigger-directly.mdx(1 hunks)docs/ce/howto/using-checkov.mdx(1 hunks)docs/ce/howto/using-infracost.mdx(1 hunks)docs/ce/howto/using-terragrunt.mdx(2 hunks)docs/ce/howto/workspaces.mdx(1 hunks)docs/ce/reference/action-inputs.mdx(2 hunks)docs/ce/reference/api.mdx(1 hunks)docs/ce/reference/digger.yml.mdx(3 hunks)docs/ce/securing-digger/external-provider.mdx(2 hunks)docs/ce/securing-digger/spec-signing.mdx(2 hunks)docs/ce/self-host/auth-methods.mdx(1 hunks)docs/ce/self-host/deploy-binary.mdx(5 hunks)docs/ce/self-host/deploy-docker-compose.mdx(4 hunks)docs/ce/self-host/deploy-docker.mdx(5 hunks)docs/ce/self-host/deploy-helm.mdx(1 hunks)docs/ce/self-host/self-host-on-azure.mdx(8 hunks)docs/ce/troubleshooting/action-errors.mdx(1 hunks)docs/ce/troubleshooting/comments.mdx(1 hunks)docs/ee/buildkite.mdx(4 hunks)docs/ee/drift-detection.mdx(3 hunks)docs/ee/ee-setup.mdx(1 hunks)docs/ee/fips-140.mdx(2 hunks)docs/ee/gitlab-support.mdx(4 hunks)docs/ee/gitlab.mdx(4 hunks)docs/ee/multi-github.mdx(2 hunks)docs/ee/opa.mdx(1 hunks)docs/ee/rbac.mdx(1 hunks)docs/mint.json(3 hunks)docs/readme/faq.mdx(1 hunks)docs/readme/feedback.mdx(1 hunks)docs/readme/introduction.mdx(1 hunks)docs/readme/pricing.mdx(3 hunks)docs/team/getting-started/gha-aws.mdx(4 hunks)
🧰 Additional context used
🧠 Learnings (38)
docs/ce/howto/using-terragrunt.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/using-checkov.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/ee-setup.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/getting-started/azure-devops.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/self-host/auth-methods.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/deploy-docker-compose.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/workspaces.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/features/private-runners.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/features/plan-persistence.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/managing-state.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/store-plans-in-a-bucket.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/howto/multiacc-aws.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ee/multi-github.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/specify-terraform-version.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/readme/pricing.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/reference/digger.yml.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/self-host/deploy-helm.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ee/gitlab-support.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/trigger-directly.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/buildkite.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/team/getting-started/gha-aws.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/securing-digger/external-provider.mdx (3)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/self-host/deploy-docker.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/readme/faq.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/readme/introduction.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/reference/api.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/self-host/self-host-on-azure.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/troubleshooting/comments.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/howto/backendless-mode.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/troubleshooting/action-errors.mdx (4)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: motatoes
PR: diggerhq/digger#1864
File: backend/controllers/projects.go:672-678
Timestamp: 2024-12-30T09:19:58.162Z
Learning: In file `backend/controllers/projects.go`, the user clarified that the AI summary token is considered non-critical, so they prefer not to validate it.
docs/ce/self-host/deploy-binary.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/getting-started/github-actions-and-gcp.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/drift-detection.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/getting-started/github-actions-+-aws.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/project-level-roles.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ee/gitlab.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/gcp/federated-oidc-access.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
🪛 LanguageTool
docs/ce/howto/apply-on-merge.mdx
[typographical] ~23-~23: It appears that a comma is missing after this introductory phrase.
Context: ...pply] ``` Limitation right now there is no way to prevent running `app...
(RIGHT_NOW_PUNCTUATION_COMMA)
docs/ee/ee-setup.mdx
[uncategorized] ~19-~19: A comma might be missing here.
Context: ... After you have the orchestrator up and running you will need a repo to test digger on....
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~21-~21: A comma might be missing here.
Context: ...r_workflow.yml` Once you have the repo ready you need to install it to the image. So...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/howto/apply-requirements.mdx
[uncategorized] ~10-~10: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...that if you have a separate status check and you have this check as “required” by br...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...heck as “required” by branch protection rules then an attempt of digger apply will no...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...required on GitHub. We are working on a fix and in the meantime you have an option ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~13-~13: A comma might be missing here.
Context: ...Hub. We are working on a fix and in the meantime you have an option to turn off the merg...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/self-host/auth-methods.mdx
[typographical] ~11-~11: It seems that a comma is missing after this introductory phrase.
Context: ...WT token, same as used in Digger Cloud. As of Jan 2024 the only supported JWT auth provider is...
(AS_OF_COMMA)
docs/ee/fips-140.mdx
[style] ~7-~7: Consider a more concise word here.
Context: ...mpiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~7-~7: A comma might be missing here.
Context: ...S140 enabled. In order to enable it for GitHub follow these steps: - For the backend ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/self-host/deploy-docker-compose.mdx
[grammar] ~94-~94: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/features/private-runners.mdx
[typographical] ~7-~7: Consider inserting a comma for improved readability.
Context: ...ger does not natively support k8s agents it is very easy to do it indirectly using ...
(MISSING_COMMAS)
[style] ~7-~7: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...s not natively support k8s agents it is very easy to do it indirectly using GitHub action...
(EN_WEAK_ADJECTIVE)
[grammar] ~7-~7: Did you mean “use”?
Context: ...nts it is very easy to do it indirectly using GitHub actions runners. In the typical ...
(DO_PRP_RB_VBG)
docs/ce/features/plan-persistence.mdx
[grammar] ~5-~5: The verb ‘apply’ does not usually follow articles like ‘an’. Check that ‘apply’ is spelled correctly; using ‘apply’ as a noun may be non-standard.
Context: ...stence" --- By default digger will run an apply based on the branch pull request files ...
(A_INFINITIVE)
[style] ~5-~5: Consider a more concise word here.
Context: ...ll request files (no artefacts stored). In order to configure plan artefacts you can config...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...cts stored). In order to configure plan artefacts you can configure the inputs for storin...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/features/pr-level-locks.mdx
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...void making a plan preview stale * For GCP locking is performed using buckets that...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~7-~7: This sentence construction might be considered wordy, consider shortening it.
Context: ...e * For GCP locking is performed using buckets that are strongly consistent: [https://GitHub.com/diggerhq/digger/bl...
(A_VERY_ORDERED_SENTENCE)
[uncategorized] ~9-~9: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ....go#L13) * These options are configured and the locking can be disabled entirely if...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~11-~11: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... not needed * The locking interface is very simple and is based on Lock() and Unlock()...
(EN_WEAK_ADJECTIVE)
docs/ce/howto/store-plans-in-a-bucket.mdx
[style] ~6-~6: Consider a more concise word here.
Context: ...acts to store terraform plan outputs. In order to enable it you can set the following arg...
(IN_ORDER_TO_PREMIUM)
[typographical] ~6-~6: It seems that a comma is missing.
Context: ...aform plan` outputs. In order to enable it you can set the following argument in d...
(IN_ORDER_TO_VB_COMMA)
docs/ce/howto/auto-merge.mdx
[uncategorized] ~17-~17: Possible missing comma found.
Context: ... on GitHub ``` If you are using GitHub VCS you can also specify `auto_merge_strate...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ee/multi-github.mdx
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...lti Tenant GitHub Connections" --- In CE version of digger during onboarding you...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...Hub Connections" --- In CE version of digger during onboarding you can use a wizard ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...s" --- In CE version of digger during onboarding you can use a wizard to create [a GitHu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... using environment variables. In larger orgs there could be a requirement that there...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...at there are multiple orgs representing department. The GitHub app created is installable ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... created is installable on a single org only unless it is published. For enterprise ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~8-~8: Possible missing comma found.
Context: ... unless it is published. For enterprise usecases publishing to GitHub marketplace is not...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~8-~8: Use a comma after an introductory phrase.
Context: ... to GitHub marketplace is not feasible. For this reason we introduced multi-tenant GitHub app v...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~9-~9: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s allow multiple app connections per org but it also makes it fully ui-based and the...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~14-~14: A comma might be missing here.
Context: ...rerequisite As a prerequisite for this step you need to have already set the enviro...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... set up multi org connections: In your backend you can visit /GitHub/connections and i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~26-~26: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ackend you can visit /GitHub/connections and it will show you a screen like below !...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~30-~30: It appears that a comma is missing.
Context: ...e/multi-tenant-GitHub.png) Within this screen you can see your current connections an...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~31-~31: The preposition ‘of’ seems more likely in this position.
Context: ... app" to follow the wizard for creation in your org. Ensure that the button on Git...
(AI_HYDRA_LEO_REPLACE_IN_OF)
[uncategorized] ~31-~31: You might be missing the article “the” here.
Context: ... in your org. Ensure that the button on GitHub side says "create in diggerhq" so it is...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~31-~31: Insert a comma before quoting reported speech: “says, "”…
Context: .... Ensure that the button on GitHub side says "create in diggerhq" so it is installed i...
(SAID_COMMA_SPEECH)
[uncategorized] ~32-~32: A comma is probably missing here.
Context: ...stalled in the right organisation. Upon success you will be redirected back to the same...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~32-~32: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...will be redirected back to the same page and you should see that connection in the t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~33-~33: A period might be missing here.
Context: ...ink to install that connection from the table Important: its important to instal...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~35-~35: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ...nnection from the table Important: its important to install using the link in ...
(AI_HYDRA_LEO_CPT_ITS_ITIS)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ortant to install using the link in the table since an additional "state" parameter i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Consider a more concise word here.
Context: ...er is passed containing app ID metadata in order to verify the app on callback. If you atte...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ... to install the created app from GitHub directly it will lead to an error.
(AI_HYDRA_LEO_MISSING_COMMA)
docs/readme/pricing.mdx
[style] ~44-~44: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...ub App) and Digger community edition is exactly the same, the difference is only where it is hos...
(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
docs/readme/feedback.mdx
[grammar] ~13-~13: The singular proper name ‘Terraform’ must be used with a third-person or a past tense verb.
Context: ...ack and feature requests) 1. Terraform file for the initial condiguration to setup ...
(HE_VERB_AGR)
docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx
[typographical] ~7-~7: It appears that a comma is missing.
Context: ...ing up GCP + GH Actions" --- In this tutorial we will be using a repository in order ...
(DURING_THAT_TIME_COMMA)
[style] ~7-~7: Consider a more concise word here.
Context: ... tutorial we will be using a repository in order to configure a terraform pipeline [https:/...
(IN_ORDER_TO_PREMIUM)
[style] ~7-~7: Consider a more concise word here.
Context: ...Hub.com/diggerhq/digger-gcp-lock-demo). In order to use GCP with Digger we follow the steps...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...cp-lock-demo). In order to use GCP with Digger we follow the steps below: Let's crea...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/reference/digger.yml.mdx
[typographical] ~171-~171: After the expression ‘for example’ a comma is usually used.
Context: ...rom | this can be used for secrets. For example you set a secret from some secret manag...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~171-~171: You might be missing the article “an” here.
Context: ...secret manager (e.g. GitHub secrets) as environment variable and the remap it to another va...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/ee/gitlab-support.mdx
[uncategorized] ~5-~5: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prere...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~10-~10: A comma might be missing here.
Context: ...icense key. If you don't have a license key please [contact us](https://calendly.co...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~16-~16: This word is normally spelled with a hyphen.
Context: ...ion steps are the same as the steps in self hosting docker with ...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~20-~20: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...kgs/container/digger_backend - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~22-~22: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~30-~30: A comma might be missing here.
Context: ...from prerequisite step) ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~30-~30: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~47-~47: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~47-~47: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~47-~47: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as "abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~49-~49: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents" are selected for Trigger events. Finally you can save. ### Create digger pipel...
(RB_LY_COMMA)
[uncategorized] ~52-~52: You might be missing the article “a” here.
Context: ...nts. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~54-~54: Possible missing comma found.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .GitLab-ci.yml file in th...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~54-~54: Consider adding a comma here.
Context: ...i.yml file in the root of your file. In this you need to create a script which downl...
(TO_THAT_COMMA)
[style] ~105-~105: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...st. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~105-~105: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~113-~113: You might be missing the article “the” here.
Context: ...ly.png) ## Repo allowlist You can set DIGGER_REPO_ALLOW_LIST env variable on ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/ee/buildkite.mdx
[style] ~34-~34: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...r cli in your buildkite agent You will need to install digger cli onto the buildkite a...
(REP_NEED_TO_VB)
[formatting] ~34-~34: Consider inserting a comma after ‘this’.
Context: ...ll digger cli onto the buildkite agent. To achieve this we can run the following we need to dow...
(TO_VERB_COMMA)
[style] ~35-~35: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...chieve this we can run the following we need to download the appropriate binary from th...
(REP_NEED_TO_VB)
docs/ce/securing-digger/external-provider.mdx
[typographical] ~15-~15: Consider adding a comma here.
Context: ... details and to engage in the discussion please take a look at this GitHub issue: https...
(PLEASE_COMMA)
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ... and to engage in the discussion please take a look at this GitHub issue: https://GitH...
(TAKE_A_LOOK)
docs/ce/self-host/deploy-docker.mdx
[grammar] ~66-~66: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/readme/faq.mdx
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ...ation.org/press/announcing-opentofu) by Linux Foundation and [pending](https://GitHub...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/ce/howto/commenting-strategies.mdx
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...requests with several plan comments for every you should chose comments per run or ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~7-~7: The modal verb ‘should’ requires the verb’s base form.
Context: ...eral plan comments for every you should chose comments per run or latest run repo...
(MD_BASEFORM)
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...ush * If you would like a more verbose output you should chose the `multiple comments...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~9-~9: The modal verb ‘should’ requires the verb’s base form.
Context: ...d like a more verbose output you should chose the multiple comments strategy * Mor...
(MD_BASEFORM)
docs/ce/self-host/self-host-on-azure.mdx
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Now you can visit /GitHub/setup endpoint and you will be greeted with this setup wiz...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~68-~68: A comma might be missing here.
Context: ...-05-26at19.00.38.png) After successful installation you will see all the GitHub credentials...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~88-~88: A comma might be missing here.
Context: ...GitHub app into the org and if all goes well we should see a succesful installation ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~88-~88: It appears that the past participle should be used here.
Context: ...tion (pick the test repo where you have terraform in)! ![Screenshot2025 05 26at19 58 03...
(HAVE_PART_AGREEMENT)
docs/ce/self-host/deploy-binary.mdx
[uncategorized] ~28-~28: Possible missing preposition found.
Context: ...s a separate binary, not to be confused the CLI agent that runs in the CI job. # C...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[grammar] ~83-~83: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/getting-started/github-actions-and-gcp.mdx
[grammar] ~91-~91: The verb ‘rely’ requires the preposition ‘on’ (or ‘upon’).
Context: ...tion; without it, subsequent steps that rely [Application Default Credentials](https...
(RELY_ON)
[uncategorized] ~92-~92: You might be missing the article “the” here.
Context: ...redentials-adc) will not work. - Set up Google Cloud SDK for use in the subsequent ste...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/ce/howto/project-level-roles.mdx
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... profile names and set them directly in terraform you can use this as an [example reposit...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...ref, sha, runner_environment etc. however it is challenging to write an AWS trust...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...sha, runner_environment` etc. however it is challenging to write an AWS trust po...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/gitlab.mdx
[uncategorized] ~6-~6: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prereq...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~16-~16: This word is normally spelled with a hyphen.
Context: ...n steps are the same as the steps in [self hosting docker](https://docs.digger.dev/self-...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ences: - For the docker image you will need to use the ee image: https://GitHub.com/di...
(REP_NEED_TO_VB)
[style] ~19-~19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ..., v0.6.5 as of this guide)** - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~21-~21: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~30-~30: A comma might be missing here.
Context: ...git.mydomain.com/api/v4 ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~30-~30: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~44-~44: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~44-~44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as “abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~44-~44: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents” are selected for Trigger events. Finally you can save. ### Create digger pipeli...
(RB_LY_COMMA)
[uncategorized] ~46-~46: You might be missing the article “a” here.
Context: ...ents. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .GitLab-ci.yml file in th...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~48-~48: Consider adding a comma here.
Context: ...i.yml file in the root of your file. In this you need to create a script which downl...
(TO_THAT_COMMA)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...need to create a script which downloads Digger binary and invokes it, the purpose here...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~48-~48: You might be missing the article “a” here.
Context: ... externally. Here is an example of such file: ```jsx variables: DIGGER_LICENSE_K...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~94-~94: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...t. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~94-~94: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/gcp/federated-oidc-access.mdx
[uncategorized] ~30-~30: Possible missing article found.
Context: ...ill be impersonated by WIF. This allows GitHub action to impersonate the service accou...
(AI_HYDRA_LEO_MISSING_A)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Security Check
🔇 Additional comments (23)
docs/ce/features/opa-policies.mdx (1)
20-20: Consistent GitHub casing – looks goodThe capitalization fix aligns with brand guidelines and improves consistency across docs.
docs/ee/opa.mdx (1)
14-15: Capitalisation looks good.The updated casing aligns with the project-wide branding change; no further action needed.
docs/ce/reference/api.mdx (1)
8-9: Link casing update accepted.Casing change is harmless and consistent with branding.
docs/ce/howto/using-infracost.mdx (1)
12-17: URL capitalization is technically fine – just noting conventionChanging
https://github.com/...→https://GitHub.com/...keeps the link working (domain names are case-insensitive) but is unconventional and may surprise some linters or copy-paste tools that normalise to lowercase. No action needed if this is a deliberate style decision across the docs.docs/ce/reference/action-inputs.mdx (1)
87-87: Good catch on proper brand capitalisationThe description now lists “GitHub” alongside the other destinations – looks correct.
docs/ce/self-host/deploy-docker-compose.mdx (1)
10-10: Path segment capitalisation might break backend routes
/GitHubin the example URL (https://…/GitHub/setup) assumes the backend’s router is case-insensitive or has been renamed. In the Digger codebase all handlers use lowercase/github. Please double-check before publishing – copy-pasting this path will 404 on existing installations.⛔ Skipped due to learnings
Learnt from: wenzel-felix PR: diggerhq/digger#1933 File: libs/storage/plan_storage.go:396-429 Timestamp: 2025-04-03T16:18:59.062Z Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.docs/ce/howto/multiacc-aws.mdx (1)
9-9: Link capitalisation OK but not requiredThe sample repo URL works either way; leave as-is if you’re standardising.
docs/ce/securing-digger/external-provider.mdx (1)
15-16: Link already corrected – looks gooddocs/ce/howto/generate-projects.mdx (1)
111-112: Good catch on the branding update.Changing “github installation ID” → “GitHub installation ID” improves consistency with the rest of the docs.
docs/ce/getting-started/gitlab-pipelines-+-aws.mdx (1)
14-21: Double-check capitalised repo & SSM paths.The updated URL (
GitHub.com/diggerhq/GitLab-webhook-lambda) and SSM examples (/GitLab-dev-webhook-handler/...) rely on case-sensitive segments outside the domain (Git repository names, SSM path keys).
If the actual repo or parameter paths remain lowercase, these instructions will mislead users.Please verify the real resource names or keep the examples lowercase.
docs/ce/getting-started/azure-devops.mdx (2)
41-42: Link casing looks good — no functional impact.URL host-part capitalisation is harmless; docs render fine and the link resolves.
74-75: LGTM on the updated link.The new capitalised host is consistent with the rest of the branding edits.
docs/ce/reference/digger.yml.mdx (1)
249-250: Clarify command scope“GitHub PR comment” could mislead readers who are using GitLab/Bitbucket. Consider making the scope explicit, e.g. “in a pull-request comment on GitHub”.
docs/ce/securing-digger/spec-signing.mdx (1)
50-51: Verify capitalisation of enum valuesIf the backend expects exact enum values (
"github"/"github_artefact"), capitalising them will cause validation failures. Please confirm whether the code recognises the new casing.Also applies to: 59-60
docs/ce/self-host/deploy-helm.mdx (1)
8-9: Avoid capitalising inside URLs & backend routesDomain names are case-insensitive, but paths often aren’t. Changing
https://diggerhq.github.io/helm-charts/→…GitHub.io…and
/github/setup→/GitHub/setuprisks 404s in some deployments and breaks
copy-paste parity with the actual backend routes exposed by the Digger
container.-1. Install the `digger-backend` helm chart from https://diggerhq.GitHub.io/helm-charts/ -2. Go to `your_digger_hostname/GitHub/setup` +1. Install the `digger-backend` helm chart from https://diggerhq.github.io/helm-charts/ +2. Go to `your_digger_hostname/github/setup`Please double-check the real endpoints before merging.
docs/ce/self-host/deploy-docker.mdx (1)
48-51: Check backend route case-sensitivityDigger backend previously exposed
/github/setup&/github/exchange-code.
Changing the docs to/GitHub/...may mislead users if the server route is
still lowercase.-Go to your_digger_hostname:3000/GitHub/setup -…redirect you to …/GitHub/exchange-code +Go to your_digger_hostname:3000/github/setup +…redirect you to …/github/exchange-codedocs/ce/azure-specific/azure.mdx (1)
17-17: Minor styleThe headings already read well; no issues beyond the context-identifier problem.
Also applies to: 35-35
docs/ee/gitlab.mdx (1)
96-99: Image path casing could lead to 404s on case-sensitive hostsThe folder was switched to
GitLab, but the actual asset path on the web-server may still be/images/ee/gitlab-1.png&/gitlab-2.png. Verify the files were renamed (or the site is case-insensitive) to avoid broken screenshots.docs/ce/self-host/deploy-binary.mdx (2)
39-40: Environment-variable example got an unexpected capital ‘H’
your_GitHub_orgchanges the value, not just the docs.
If users paste this straight into their shell scripts they will get a different organisation name. Consider keeping it lower-case or adding a note that the value is arbitrary.
83-84: Internal link may break after path-casing changeThe route
/ce/getting-started/GitHub-actions-+-awswas capitalised. The static site generator/server may treat paths as case-sensitive.docs/ce/howto/project-level-roles.mdx (1)
60-61: AWS role name capitalisation may matterIAM role names are case-sensitive. Changing the example from
github-action-deployment-roletoGitHub-action-deployment-rolecould confuse readers who copied the previous example verbatim.docs/ce/self-host/self-host-on-azure.mdx (1)
62-63: Endpoint case-sensitivity – confirm it’s really/GitHub/setup.If the router was mounted as
/github/setuporiginally, changing the case here may mislead users because URLs on most back-ends are case sensitive. Please verify.docs/readme/introduction.mdx (1)
32-32: LGTM – correct “GitLab CI” capitalizationThe branding fix is accurate and improves consistency.
gecube
force-pushed
the
github-gitlab-naming
branch
4 times, most recently
from
c5e21a5 to
6490ae8
Compare
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (3)
docs/ee/gitlab.mdx (1)
24-27:DIGGER_CI_BACKENDvalue will break setups – keep it lowercaseBackend code only recognises the literal string
gitlab_pipelines.
Changing it toGitLab_pipelineswill cause the orchestrator to reject events.-DIGGER_CI_BACKEND=GitLab_pipelines +DIGGER_CI_BACKEND=gitlab_pipelinesdocs/ee/gitlab-support.mdx (2)
30-31: Still references a GitHub app in a GitLab guide
Issue already raised in previous review and not fixed.
53-54:.GitLab-ci.ymlcapitalisation breaks CI discovery
GitLab only picks up.gitlab-ci.yml(all lowercase).
Please change the filename.
🧹 Nitpick comments (20)
docs/ce/features/plan-persistence.mdx (1)
5-5: Clarify wording & fix minor grammar/punctuation-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. +By default Digger runs the apply step directly from the pull-request files (no artefacts are stored). To persist plans you can configure GitHub artefacts, AWS buckets or GCP buckets via the corresponding inputs.This tightens the sentence, adds missing commas, and capitalises vendor names consistently.
docs/ce/howto/auto-merge.mdx (1)
17-17: Insert missing comma after introductory clause-If you are using GitHub VCS you can also specify +If you are using GitHub VCS, you can also specifyAdds a needed pause and aligns with standard style used elsewhere in the docs.
docs/ce/howto/trigger-directly.mdx (1)
7-7: Improve readability & punctuation of long sentence-But in some scenarios e.g. small projects that have no need for concurrency, it might be easier to just use a standalone action triggered directly from github.events. +However, in some scenarios—e.g., small projects that do not need concurrency—it may be easier to use a standalone Action triggered directly from `github` events.Uses a clearer transition, corrects “e.g.” punctuation, streamlines wording, and quotes the
githubcontext object.docs/ce/howto/apply-requirements.mdx (1)
13-13: Fix typo in “mergeability”- cause the "mergability" check to conflict if you set the digger/apply check as required on GitHub. + cause the "mergeability" check to conflict if you set the digger/apply check as required on GitHub.Corrects spelling while leaving the rest of the sentence intact.
docs/ee/fips-140.mdx (2)
7-7: Correct spelling & tighten phrasing-as of version v0.6.101 digger backend and cli are both compiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps: +As of version v0.6.101, the Digger backend and CLI are compiled separately with FIPS-140 enabled. To enable it for GitHub, follow these steps:Fixes “separately”, inserts commas, and removes unnecessary “In order to”.
19-19: Add commas & hyphenate “FIPS-enabled”-If you are using GitLab or other VCS then just ensure that you are downloading the fips enabled binary which is suffixed with '_fips' +If you are using GitLab or another VCS, ensure that you download the FIPS-enabled binary, which is suffixed with `_fips`.Improves flow and applies correct hyphenation/capitalisation.
docs/ee/ee-setup.mdx (2)
15-16: Tighten wording & remove duplication.Current sentence repeats “internally” and uses a run-on structure. A crisper alternative also clarifies that the GitHub App has been “set up”, not “setup”.
-By the end of this you should have your orchestrator up and running internally, you will also have setup the internal GitHub app for your org internally. +By the end of this guide, you should have your orchestrator running internally and have set up the internal GitHub App for your organisation.
21-22: Minor grammar: missing comma & awkward phrasing.-Once you have the repo ready you need to install it to the image. So make sure to install the GitHub app in your organisation, adding the POC repository to it. +Once the repository is ready, install the GitHub App in your organisation and add the POC repository to it.docs/ce/securing-digger/external-provider.mdx (1)
15-16: Insert comma for readability.-...details and to engage in the discussion please take a look at this GitHub issue: +...details and, to engage in the discussion, please see this GitHub issue:docs/ce/reference/digger.yml.mdx (1)
171-172: Comma after “For example” + typo “the remap”.-...For example you set a secret from some secret manager (e.g. GitHub secrets) as environment variable and the remap it to another variable. +...For example, you can set a secret from a secret manager (e.g. GitHub Secrets) as an environment variable and then remap it to another variable.docs/ce/features/private-runners.mdx (2)
7-8: Improve clarity & fix capitalization.-While digger does not natively support k8s agents it is very easy to do it indirectly using GitHub actions runners. +While Digger does not natively support Kubernetes agents, you can achieve this indirectly by using GitHub Actions runners.
19-21: Comma after “specifically” & capitalise “Actions”.-With GitHub specifically there is good support for [self-hosted runners]... +With GitHub, specifically, there is good support for [self-hosted runners]... -which means that you can create agents for GitHub actions in your private infrastructure's VPC and GitHub will then run the jobs there. +which means you can create agents for GitHub Actions in your private infrastructure's VPC, and GitHub will then run the jobs there.docs/ce/howto/project-level-roles.mdx (1)
46-49: Spelling & punctuation fixes.-The GitHub action JWT token includes alot of useful fields such as `ref`, `sha`, `runner_environment` etc. however it is +The GitHub Actions JWT token includes a lot of useful fields such as `ref`, `sha`, `runner_environment`, etc., however, it is(Only the first sentence shown; adjust following sentence’s leading lowercase “challenging” to maintain flow.)
docs/ce/gcp/federated-oidc-access.mdx (1)
30-31: Minor wording tweak“For a GitHub action” → “for GitHub Actions” (proper product name, plural).
-This allows GitHub action to impersonate the service account +This allows GitHub Actions to impersonate the service accountdocs/readme/pricing.mdx (1)
42-45: Streamline phrasingThe sentence is a bit wordy. Consider:
-All of Digger is open source, even the enterprise edition. The feature set of Digger cloud (GitHub App) and Digger community edition is exactly the same, the difference is only where it is hosted. +All of Digger is open source, including the enterprise edition. The feature set of Digger Cloud (GitHub App) and the community edition is identical; the only difference is the hosting location.docs/ce/howto/store-plans-in-a-bucket.mdx (1)
5-7: Tighten wording-Digger can use GitHub Artifacts to store `terraform plan` outputs. In order to enable it you can set the following argument in digger_workflow.yml: +Digger can use GitHub Artifacts to store `terraform plan` outputs. To enable this, set the following argument in `digger_workflow.yml`:docs/ee/multi-github.mdx (2)
6-9: Improve readability & fix minor grammarA few small wording issues make these key introductory sentences a bit hard to parse (missing articles, plural, hyphen).
-In larger orgs there could be a requirement that there are multiple orgs representing department. +In larger organisations, there may be a requirement for multiple orgs representing departments. -For enterprise usecases publishing to GitHub marketplace is not feasible. +For enterprise use-cases, publishing to the GitHub Marketplace is not feasible.
35-36: Possessive “it’s” instead of “its”-**Important**: its important to install using the link in the table +**Important**: it’s important to install using the link in the tabledocs/ee/gitlab.mdx (1)
93-94: Duplicate “also” – tighten sentence-Your GitLab should also trigger and also perform a plan. +Your GitLab should trigger and perform a plan as well.docs/ce/self-host/self-host-on-azure.mdx (1)
51-52: Capital letters in repository URL are unnecessary
https://diggerhq.GitHub.io/helm-charts/works because DNS is case-insensitive, but using lowercase (github.io) avoids surprising readers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
docs/ce/azure-specific/azure.mdx(2 hunks)docs/ce/features/opa-policies.mdx(1 hunks)docs/ce/features/plan-persistence.mdx(1 hunks)docs/ce/features/plan-preview.mdx(1 hunks)docs/ce/features/private-runners.mdx(2 hunks)docs/ce/gcp/federated-oidc-access.mdx(3 hunks)docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx(1 hunks)docs/ce/getting-started/github-actions-+-aws.mdx(2 hunks)docs/ce/getting-started/github-actions-and-gcp.mdx(3 hunks)docs/ce/getting-started/gitlab-pipelines-+-aws.mdx(1 hunks)docs/ce/howto/apply-requirements.mdx(1 hunks)docs/ce/howto/auto-merge.mdx(1 hunks)docs/ce/howto/generate-projects.mdx(1 hunks)docs/ce/howto/project-level-roles.mdx(1 hunks)docs/ce/howto/store-plans-in-a-bucket.mdx(1 hunks)docs/ce/howto/trigger-directly.mdx(1 hunks)docs/ce/reference/action-inputs.mdx(1 hunks)docs/ce/reference/digger.yml.mdx(3 hunks)docs/ce/securing-digger/external-provider.mdx(2 hunks)docs/ce/securing-digger/spec-signing.mdx(2 hunks)docs/ce/self-host/deploy-binary.mdx(4 hunks)docs/ce/self-host/deploy-docker-compose.mdx(4 hunks)docs/ce/self-host/deploy-docker.mdx(5 hunks)docs/ce/self-host/deploy-helm.mdx(1 hunks)docs/ce/self-host/self-host-on-azure.mdx(6 hunks)docs/ee/buildkite.mdx(3 hunks)docs/ee/drift-detection.mdx(1 hunks)docs/ee/ee-setup.mdx(1 hunks)docs/ee/fips-140.mdx(2 hunks)docs/ee/gitlab-support.mdx(4 hunks)docs/ee/gitlab.mdx(3 hunks)docs/ee/multi-github.mdx(2 hunks)docs/mint.json(1 hunks)docs/readme/feedback.mdx(1 hunks)docs/readme/introduction.mdx(1 hunks)docs/readme/pricing.mdx(3 hunks)docs/team/getting-started/gha-aws.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (11)
- docs/ee/drift-detection.mdx
- docs/team/getting-started/gha-aws.mdx
- docs/ce/getting-started/github-actions-+-aws.mdx
- docs/ce/azure-specific/azure.mdx
- docs/mint.json
- docs/ce/self-host/deploy-helm.mdx
- docs/ce/securing-digger/spec-signing.mdx
- docs/ce/getting-started/github-actions-and-gcp.mdx
- docs/ce/getting-started/gitlab-pipelines-+-aws.mdx
- docs/ee/buildkite.mdx
- docs/readme/feedback.mdx
🚧 Files skipped from review as they are similar to previous changes (6)
- docs/ce/features/opa-policies.mdx
- docs/ce/features/plan-preview.mdx
- docs/ce/reference/action-inputs.mdx
- docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx
- docs/ce/howto/generate-projects.mdx
- docs/readme/introduction.mdx
🧰 Additional context used
🧠 Learnings (16)
docs/ce/features/plan-persistence.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/features/private-runners.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/apply-requirements.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/store-plans-in-a-bucket.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/trigger-directly.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/reference/digger.yml.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/securing-digger/external-provider.mdx (3)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/self-host/deploy-binary.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/deploy-docker-compose.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/deploy-docker.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/self-host-on-azure.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ee/ee-setup.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/gitlab-support.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/gitlab.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ee/multi-github.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/readme/pricing.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
🪛 LanguageTool
docs/ce/features/plan-persistence.mdx
[grammar] ~5-~5: The verb ‘apply’ does not usually follow articles like ‘an’. Check that ‘apply’ is spelled correctly; using ‘apply’ as a noun may be non-standard.
Context: ...stence" --- By default digger will run an apply based on the branch pull request files ...
(A_INFINITIVE)
[style] ~5-~5: Consider a more concise word here.
Context: ...ll request files (no artefacts stored). In order to configure plan artefacts you can config...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...cts stored). In order to configure plan artefacts you can configure the inputs for storin...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/features/private-runners.mdx
[typographical] ~7-~7: Consider inserting a comma for improved readability.
Context: ...ger does not natively support k8s agents it is very easy to do it indirectly using ...
(MISSING_COMMAS)
[style] ~7-~7: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...s not natively support k8s agents it is very easy to do it indirectly using GitHub action...
(EN_WEAK_ADJECTIVE)
[grammar] ~7-~7: Did you mean “use”?
Context: ...nts it is very easy to do it indirectly using GitHub actions runners. In the typical ...
(DO_PRP_RB_VBG)
docs/ce/gcp/federated-oidc-access.mdx
[uncategorized] ~30-~30: Possible missing article found.
Context: ...ill be impersonated by WIF. This allows GitHub action to impersonate the service accou...
(AI_HYDRA_LEO_MISSING_A)
docs/ce/howto/apply-requirements.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...required on GitHub. We are working on a fix and in the meantime you have an option ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~13-~13: A comma might be missing here.
Context: ...Hub. We are working on a fix and in the meantime you have an option to turn off the merg...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/howto/auto-merge.mdx
[uncategorized] ~17-~17: Possible missing comma found.
Context: ... on GitHub ``` If you are using GitHub VCS you can also specify `auto_merge_strate...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/howto/project-level-roles.mdx
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...ref, sha, runner_environment etc. however it is challenging to write an AWS trust...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...sha, runner_environment` etc. however it is challenging to write an AWS trust po...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/howto/store-plans-in-a-bucket.mdx
[style] ~6-~6: Consider a more concise word here.
Context: ...acts to store terraform plan outputs. In order to enable it you can set the following arg...
(IN_ORDER_TO_PREMIUM)
[typographical] ~6-~6: It seems that a comma is missing.
Context: ...aform plan` outputs. In order to enable it you can set the following argument in d...
(IN_ORDER_TO_VB_COMMA)
docs/ce/howto/trigger-directly.mdx
[uncategorized] ~7-~7: A comma might be missing here.
Context: ...os this can get expensive. But in some scenarios e.g. small projects that have no need f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/reference/digger.yml.mdx
[typographical] ~171-~171: After the expression ‘for example’ a comma is usually used.
Context: ...rom | this can be used for secrets. For example you set a secret from some secret manag...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~171-~171: You might be missing the article “an” here.
Context: ...secret manager (e.g. GitHub secrets) as environment variable and the remap it to another va...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/ce/securing-digger/external-provider.mdx
[typographical] ~15-~15: Consider adding a comma here.
Context: ... details and to engage in the discussion please take a look at this GitHub issue: https...
(PLEASE_COMMA)
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ... and to engage in the discussion please take a look at this GitHub issue: https://gith...
(TAKE_A_LOOK)
docs/ce/self-host/deploy-binary.mdx
[grammar] ~83-~83: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/self-host/deploy-docker-compose.mdx
[grammar] ~94-~94: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/self-host/deploy-docker.mdx
[grammar] ~66-~66: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/self-host/self-host-on-azure.mdx
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Now you can visit /GitHub/setup endpoint and you will be greeted with this setup wiz...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~68-~68: A comma might be missing here.
Context: ...-05-26at19.00.38.png) After successful installation you will see all the GitHub credentials...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~88-~88: A comma might be missing here.
Context: ...GitHub app into the org and if all goes well we should see a succesful installation ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~88-~88: It appears that the past participle should be used here.
Context: ...tion (pick the test repo where you have terraform in)! ![Screenshot2025 05 26at19 58 03...
(HAVE_PART_AGREEMENT)
docs/ee/ee-setup.mdx
[uncategorized] ~19-~19: A comma might be missing here.
Context: ... After you have the orchestrator up and running you will need a repo to test digger on....
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~21-~21: A comma might be missing here.
Context: ...r_workflow.yml` Once you have the repo ready you need to install it to the image. So...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/fips-140.mdx
[style] ~7-~7: Consider a more concise word here.
Context: ...mpiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~7-~7: A comma might be missing here.
Context: ...S140 enabled. In order to enable it for GitHub follow these steps: - For the backend ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/gitlab-support.mdx
[uncategorized] ~5-~5: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prere...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~10-~10: A comma might be missing here.
Context: ...icense key. If you don't have a license key please [contact us](https://calendly.co...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~13-~13: Possible missing preposition found.
Context: ...om User Preferences > Access Tokens ### Install the digger EE orchestrator: You need t...
(AI_HYDRA_LEO_MISSING_TO)
[misspelling] ~15-~15: This word is normally spelled with a hyphen.
Context: ...ion steps are the same as the steps in self hosting docker with ...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~19-~19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...kgs/container/digger_backend - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~21-~21: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...from prerequisite step) ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~29-~29: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~46-~46: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~47-~47: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as "abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~48-~48: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents" are selected for Trigger events. Finally you can save. ### Create digger pipel...
(RB_LY_COMMA)
[uncategorized] ~51-~51: You might be missing the article “a” here.
Context: ...nts. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~53-~53: Possible missing comma found.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .GitLab-ci.yml file in th...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~53-~53: Consider adding a comma here.
Context: ...i.yml file in the root of your file. In this you need to create a script which downl...
(TO_THAT_COMMA)
[style] ~104-~104: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...st. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~104-~104: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~112-~112: You might be missing the article “the” here.
Context: ...ly.png) ## Repo allowlist You can set DIGGER_REPO_ALLOW_LIST env variable on ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/ee/gitlab.mdx
[uncategorized] ~6-~6: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prereq...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~16-~16: This word is normally spelled with a hyphen.
Context: ...n steps are the same as the steps in [self hosting docker](https://docs.digger.dev/self-...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ences: - For the docker image you will need to use the ee image: https://github.com/di...
(REP_NEED_TO_VB)
[style] ~19-~19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ..., v0.6.5 as of this guide)** - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~21-~21: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~30-~30: A comma might be missing here.
Context: ...git.mydomain.com/api/v4 ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~30-~30: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~44-~44: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~44-~44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as “abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~44-~44: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents” are selected for Trigger events. Finally you can save. ### Create digger pipeli...
(RB_LY_COMMA)
[uncategorized] ~46-~46: You might be missing the article “a” here.
Context: ...ents. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~48-~48: A comma might be missing here.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .gitlab-ci.yml file in th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~48-~48: Consider adding a comma here.
Context: ...file in the root of your repository. In this you need to create a script which downl...
(TO_THAT_COMMA)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...need to create a script which downloads Digger binary and invokes it, the purpose here...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~48-~48: You might be missing the article “a” here.
Context: ... externally. Here is an example of such file: ```jsx variables: DIGGER_LICENSE_KE...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~93-~93: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...t. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~93-~93: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/multi-github.mdx
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...lti Tenant GitHub Connections" --- In CE version of digger during onboarding you...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...Hub Connections" --- In CE version of digger during onboarding you can use a wizard ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...s" --- In CE version of digger during onboarding you can use a wizard to create [a GitHu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... using environment variables. In larger orgs there could be a requirement that there...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...at there are multiple orgs representing department. The GitHub app created is installable ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... created is installable on a single org only unless it is published. For enterprise ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~8-~8: Possible missing comma found.
Context: ... unless it is published. For enterprise usecases publishing to GitHub marketplace is not...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~8-~8: Use a comma after an introductory phrase.
Context: ... to GitHub marketplace is not feasible. For this reason we introduced multi-tenant GitHub app v...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~9-~9: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s allow multiple app connections per org but it also makes it fully ui-based and the...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~14-~14: A comma might be missing here.
Context: ...rerequisite As a prerequisite for this step you need to have already set the enviro...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... set up multi org connections: In your backend you can visit /GitHub/connections and i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~26-~26: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ackend you can visit /GitHub/connections and it will show you a screen like below !...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~30-~30: It appears that a comma is missing.
Context: ...e/multi-tenant-GitHub.png) Within this screen you can see your current connections an...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~31-~31: The preposition ‘of’ seems more likely in this position.
Context: ... app" to follow the wizard for creation in your org. Ensure that the button on Git...
(AI_HYDRA_LEO_REPLACE_IN_OF)
[uncategorized] ~31-~31: You might be missing the article “the” here.
Context: ... in your org. Ensure that the button on GitHub side says "create in diggerhq" so it is...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~31-~31: Insert a comma before quoting reported speech: “says, "”…
Context: .... Ensure that the button on GitHub side says "create in diggerhq" so it is installed i...
(SAID_COMMA_SPEECH)
[uncategorized] ~32-~32: A comma is probably missing here.
Context: ...stalled in the right organisation. Upon success you will be redirected back to the same...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~32-~32: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...will be redirected back to the same page and you should see that connection in the t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~33-~33: A period might be missing here.
Context: ...ink to install that connection from the table Important: its important to instal...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~35-~35: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ...nnection from the table Important: its important to install using the link in ...
(AI_HYDRA_LEO_CPT_ITS_ITIS)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ortant to install using the link in the table since an additional "state" parameter i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Consider a more concise word here.
Context: ...er is passed containing app ID metadata in order to verify the app on callback. If you atte...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ... to install the created app from GitHub directly it will lead to an error.
(AI_HYDRA_LEO_MISSING_COMMA)
docs/readme/pricing.mdx
[grammar] ~43-~43: Consider using “All Digger” or “All of the Digger”.
Context: ...ich parts of Digger are Open Source?** All of Digger is open source, even the enterprise edi...
(ALL_MOST_SOME_OF_NOUN)
[style] ~44-~44: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...ub App) and Digger community edition is exactly the same, the difference is only where it is hos...
(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Security Check
🔇 Additional comments (2)
docs/ce/self-host/deploy-docker-compose.mdx (1)
94-96: Typo & link-case verification
it's→ possessiveits.- The target file
/ce/getting-started/GitHub-actions-+-awsmay not exist on case-sensitive hosts (previously lower-case).-From here on it's the same steps as in the [Quickstart](/ce/getting-started/GitHub-actions-+-aws): +From here on its steps match those in the [Quickstart](/ce/getting-started/github-actions-+-aws):docs/ce/self-host/deploy-binary.mdx (1)
83-84: Grammar & potential broken linkSame two issues as in the docker-compose guide:
-From here on it's the same steps as in the [Quickstart](/ce/getting-started/GitHub-actions-+-aws): +From here on its steps match those in the [Quickstart](/ce/getting-started/github-actions-+-aws):Please verify the updated URL actually resolves on your docs site; many static hosts treat paths as case-sensitive.
gecube
force-pushed
the
github-gitlab-naming
branch
from
aa6ed5b to
e7e2fc1
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
docs/ee/gitlab-support.mdx (2)
5-5: Add comma after ‘Currently’Same punctuation issue as the other file.
-... CI backend. Currently this is an EE feature only. +... CI backend. Currently, this is an EE feature only.
30-31: Remove leftover GitHub reference – this is a GitLab guideThe sentence still says “along with a GitHub app successfully installed”.
Either drop the sentence or replace it with wording relevant to the GitLab webhook.
🧹 Nitpick comments (24)
docs/ce/features/plan-persistence.mdx (1)
5-5: Tighten wording & capitalize cloud providers consistently
Sentence is a bit clunky and mixes capitalisation (aws,gcp) after fixingGitHub. Suggest trimming filler and capitalising provider names for consistency.-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. +By default Digger runs an apply against the pull-request files (no artefacts are stored). To persist plan artefacts, configure the inputs to store them as GitHub artefacts, AWS buckets or GCP buckets.docs/ce/howto/auto-merge.mdx (1)
14-18: Minor grammar: add comma after “VCS”
Reads more naturally with a comma, and avoids momentary parse confusion.-If you are using GitHub VCS you can also specify +If you are using GitHub as your VCS, you can also specifydocs/ce/howto/apply-requirements.mdx (1)
13-14: Fix spelling of “mergeability” & add comma- cause the "mergability" check to conflict if you set the digger/apply check as required on GitHub. We are working on a fix + cause the “mergeability” check to conflict if you set the digger/apply check as required on GitHub, and we are working on a fixdocs/ce/howto/trigger-directly.mdx (1)
7-8: Clarify phrasing of event source
github.eventslooks like a code element but it’s used as prose. Consider re-phrasing to avoid confusion with the Actions context object.-it might be easier to just use a standalone action triggered directly from github.events. +it might be easier to use a standalone action triggered directly from GitHub events.docs/ee/fips-140.mdx (2)
7-9: Spelling & punctuation fixes
“seperately” → “separately”, add comma after “GitHub”, trim “In order to”.-as of version v0.6.101 digger backend and cli are both compiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps: +As of version v0.6.101 the Digger backend and CLI are both compiled separately with FIPS-140 enabled. To enable it for GitHub, follow these steps:
19-19: Hyphenate & comma for readability-If you are using GitLab or other VCS then just ensure that you are downloading the fips enabled binary which is suffixed with '_fips' +If you are using GitLab or another VCS, ensure you download the FIPS-enabled binary, suffixed with `_fips`.docs/ce/securing-digger/external-provider.mdx (2)
5-6: Capitalize “Terraform” consistently-Digger executes Terraform in GitHub Actions within privileged environments. Since terraform has the ability +Digger executes Terraform in GitHub Actions within privileged environments. Since Terraform has the ability
13-15: Minor grammar & terminology clean-up-Secondly its important to ensure that only trusted individuals are allowed to update the terraform code. +Secondly, it's important to ensure that only trusted individuals are allowed to update the Terraform code. -For more details and to engage in the discussion please take a look at this GitHub issue: +For more details, and to engage in the discussion, please take a look at this GitHub issue:docs/ee/ee-setup.mdx (2)
15-16: Verb form + sentence flow-By the end of this you should have your orchestrator up and running internally, you will also have setup the internal GitHub app for your org internally. +By the end of this process, you should have your orchestrator running internally and have set up the internal GitHub app for your organisation.
21-22: Tighten wording & remove filler-Once you have the repo ready you need to install it to the image. So make sure to install the GitHub app in your organisation, adding the POC repository to it. +Once the repository is ready, install the GitHub app in your organisation and add the POC repository to it.docs/ce/gcp/federated-oidc-access.mdx (1)
30-31: Use product name “GitHub Actions”-This allows GitHub action to impersonate the service account and get a token. +This allows GitHub Actions to impersonate the service account and obtain a token.docs/ce/features/private-runners.mdx (2)
7-8: Grammar & clarity-While digger does not natively support k8s agents it is very easy to do it indirectly using GitHub actions runners. +Although Digger does not natively support Kubernetes agents, you can achieve the same result indirectly by using GitHub Actions runners.
19-20: Capitalize “GitHub Actions” & streamline-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) -which means that you can create agents for GitHub actions in your private infrastructure's VPC and GitHub will then run the jobs there. +GitHub has first-class support for [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners), +so you can provision GitHub Actions agents inside your private infrastructure’s VPC and have your jobs executed there.docs/ce/howto/store-plans-in-a-bucket.mdx (1)
5-6: Concise wording & comma-Digger can use GitHub Artifacts to store `terraform plan` outputs. In order to enable it you can set the following argument in digger_workflow.yml: +Digger can use GitHub Artifacts to store `terraform plan` outputs. To enable this, set the following argument in `digger_workflow.yml`:docs/ce/reference/digger.yml.mdx (2)
105-105: Add missing verb in “GitHub supported” noteThe sentence reads awkwardly without a verb.
- | ... | currently only GitHub supported for this flag | + | ... | currently only GitHub is supported for this flag |
170-172: Tighten up “value_from” explanation & fix typosMinor grammar tweaks improve readability and remove the “the remap” typo.
- this can be used for secrets. For example you set a secret from some secret manager (e.g. GitHub secrets) as environment variable and the remap it to another variable. E.g. setting DEV_TF_ACCESS_KEY as a secret in GitHub action, but then remap it into AWS_ACCESS_KEY during terraform apply command execution | + This can be used for secrets. For example, you can set a secret from a secret manager (e.g., GitHub Secrets) as an environment variable and then remap it to another variable—for instance, setting `DEV_TF_ACCESS_KEY` as a secret in a GitHub Action and remapping it to `AWS_ACCESS_KEY` during the Terraform apply step. |docs/ee/multi-github.mdx (3)
2-2: Hyphenate compound adjective in title-title: "Multi Tenant GitHub Connections" +title: "Multi-Tenant GitHub Connections"
6-9: Polish first-paragraph grammar & clarityConsider the edits below to fix plurals, punctuation and flow:
-In CE version of digger during onboarding you can use a wizard ... +In the CE version of Digger, during onboarding, you can use a wizard ... -In larger orgs there could be a requirement that there are multiple orgs representing department. +In larger organisations, there may be several GitHub organisations representing different departments. -For enterprise usecases publishing to GitHub marketplace is not feasible. +For many enterprise use-cases, publishing to the GitHub Marketplace is not feasible. -Not only does this allow multiple app connections per org but it also makes it fully ui-based and there is no need to set environment variables. +This feature allows multiple App connections per organisation, provides a fully UI-driven flow, and removes the need for environment variables.
35-36: Fix “its” → “it’s” and compress long sentence-**Important**: its important to install using the link in the table since an additional "state" parameter is passed containing app ID metadata in order to verify the app on callback. If you attempt to install the created app from GitHub directly it will lead to an error. +**Important**: It’s important to install the App using the link in the table; the link passes a `state` parameter with App-ID metadata used to verify the App on callback. Installing directly from GitHub will result in an error.docs/readme/pricing.mdx (1)
42-46: Streamline wording & fix “GitHub Only” capitalisation-All of Digger is open source, even the enterprise edition. The feature set of Digger cloud (GitHub App) and Digger community edition is exactly the same, the difference is only where it is hosted. Please note that Digger Cloud is GitHub Only, for Bitbucket & GitLab you'd have to Self Manage it, unless you want a dedicated instance under an enterprise license. +All of Digger is open source, including the enterprise edition. The feature sets of Digger Cloud (GitHub App) and the Community Edition are identical—the only difference is hosting location. Note that Digger Cloud is GitHub-only; for Bitbucket or GitLab you’ll need to self-manage unless you opt for a dedicated enterprise instance.docs/ee/gitlab.mdx (1)
6-6: Add a comma after ‘Currently’ for correct punctuation-... CI backend. Currently this is an EE feature only. +... CI backend. Currently, this is an EE feature only.docs/ce/self-host/self-host-on-azure.mdx (3)
13-14: Use lowercase domain in Helm repo URL-Install the `digger-backend` helm chart from https://diggerhq.GitHub.io/helm-charts/ +Install the `digger-backend` helm chart from https://diggerhq.github.io/helm-charts/Domain names are case-insensitive, but using the canonical lowercase form avoids confusion and keeps examples consistent.
5-5: Clarify wording and remove duplicate “workflow”-... and setup your GitHub workflow to trigger workflow on azure! +... and set up your GitHub workflow to trigger runs on Azure!
9-10: Typo & grammatical fix-... helmchart in kubernetes. The deployed service needs to be able to listen ... +... Helm chart in Kubernetes. The deployed service must listen ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (38)
action.yml(1 hunks)docs/ce/azure-specific/azure.mdx(2 hunks)docs/ce/features/opa-policies.mdx(1 hunks)docs/ce/features/plan-persistence.mdx(1 hunks)docs/ce/features/plan-preview.mdx(1 hunks)docs/ce/features/private-runners.mdx(2 hunks)docs/ce/gcp/federated-oidc-access.mdx(3 hunks)docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx(1 hunks)docs/ce/getting-started/github-actions-+-aws.mdx(2 hunks)docs/ce/getting-started/github-actions-and-gcp.mdx(3 hunks)docs/ce/getting-started/gitlab-pipelines-+-aws.mdx(1 hunks)docs/ce/howto/apply-requirements.mdx(1 hunks)docs/ce/howto/auto-merge.mdx(1 hunks)docs/ce/howto/generate-projects.mdx(1 hunks)docs/ce/howto/project-level-roles.mdx(1 hunks)docs/ce/howto/store-plans-in-a-bucket.mdx(1 hunks)docs/ce/howto/trigger-directly.mdx(1 hunks)docs/ce/reference/action-inputs.mdx(1 hunks)docs/ce/reference/digger.yml.mdx(3 hunks)docs/ce/securing-digger/external-provider.mdx(2 hunks)docs/ce/securing-digger/spec-signing.mdx(2 hunks)docs/ce/self-host/deploy-binary.mdx(4 hunks)docs/ce/self-host/deploy-docker-compose.mdx(4 hunks)docs/ce/self-host/deploy-docker.mdx(4 hunks)docs/ce/self-host/deploy-helm.mdx(1 hunks)docs/ce/self-host/self-host-on-azure.mdx(6 hunks)docs/ee/buildkite.mdx(3 hunks)docs/ee/drift-detection.mdx(1 hunks)docs/ee/ee-setup.mdx(1 hunks)docs/ee/fips-140.mdx(2 hunks)docs/ee/gitlab-support.mdx(4 hunks)docs/ee/gitlab.mdx(3 hunks)docs/ee/multi-github.mdx(2 hunks)docs/mint.json(1 hunks)docs/readme/feedback.mdx(1 hunks)docs/readme/introduction.mdx(1 hunks)docs/readme/pricing.mdx(3 hunks)docs/team/getting-started/gha-aws.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (11)
- docs/ee/drift-detection.mdx
- docs/team/getting-started/gha-aws.mdx
- docs/ce/self-host/deploy-docker.mdx
- docs/ee/buildkite.mdx
- docs/ce/getting-started/github-actions-+-aws.mdx
- docs/readme/feedback.mdx
- docs/ce/azure-specific/azure.mdx
- docs/ce/getting-started/github-actions-and-gcp.mdx
- docs/ce/self-host/deploy-helm.mdx
- docs/ce/getting-started/gitlab-pipelines-+-aws.mdx
- action.yml
🚧 Files skipped from review as they are similar to previous changes (8)
- docs/ce/features/plan-preview.mdx
- docs/ce/features/opa-policies.mdx
- docs/ce/reference/action-inputs.mdx
- docs/ce/howto/generate-projects.mdx
- docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx
- docs/readme/introduction.mdx
- docs/mint.json
- docs/ce/securing-digger/spec-signing.mdx
🧰 Additional context used
🧠 Learnings (15)
docs/ce/features/plan-persistence.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/features/private-runners.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/apply-requirements.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/store-plans-in-a-bucket.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/trigger-directly.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/reference/digger.yml.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/securing-digger/external-provider.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/deploy-binary.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/deploy-docker-compose.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/self-host/self-host-on-azure.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ee/ee-setup.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/gitlab-support.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/gitlab.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ee/multi-github.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/readme/pricing.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
🪛 LanguageTool
docs/ce/features/plan-persistence.mdx
[grammar] ~5-~5: The verb ‘apply’ does not usually follow articles like ‘an’. Check that ‘apply’ is spelled correctly; using ‘apply’ as a noun may be non-standard.
Context: ...stence" --- By default digger will run an apply based on the branch pull request files ...
(A_INFINITIVE)
[style] ~5-~5: Consider a more concise word here.
Context: ...ll request files (no artefacts stored). In order to configure plan artefacts you can config...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...cts stored). In order to configure plan artefacts you can configure the inputs for storin...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/features/private-runners.mdx
[typographical] ~7-~7: Consider inserting a comma for improved readability.
Context: ...ger does not natively support k8s agents it is very easy to do it indirectly using ...
(MISSING_COMMAS)
[style] ~7-~7: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...s not natively support k8s agents it is very easy to do it indirectly using GitHub action...
(EN_WEAK_ADJECTIVE)
[grammar] ~7-~7: Did you mean “use”?
Context: ...nts it is very easy to do it indirectly using GitHub actions runners. In the typical ...
(DO_PRP_RB_VBG)
docs/ce/gcp/federated-oidc-access.mdx
[uncategorized] ~30-~30: Possible missing article found.
Context: ...ill be impersonated by WIF. This allows GitHub action to impersonate the service accou...
(AI_HYDRA_LEO_MISSING_A)
docs/ce/howto/apply-requirements.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...required on GitHub. We are working on a fix and in the meantime you have an option ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~13-~13: A comma might be missing here.
Context: ...Hub. We are working on a fix and in the meantime you have an option to turn off the merg...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/howto/auto-merge.mdx
[uncategorized] ~17-~17: Possible missing comma found.
Context: ... on GitHub ``` If you are using GitHub VCS you can also specify `auto_merge_strate...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/ce/howto/project-level-roles.mdx
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...ref, sha, runner_environment etc. however it is challenging to write an AWS trust...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...sha, runner_environment` etc. however it is challenging to write an AWS trust po...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/howto/store-plans-in-a-bucket.mdx
[style] ~6-~6: Consider a more concise word here.
Context: ...acts to store terraform plan outputs. In order to enable it you can set the following arg...
(IN_ORDER_TO_PREMIUM)
[typographical] ~6-~6: It seems that a comma is missing.
Context: ...aform plan` outputs. In order to enable it you can set the following argument in d...
(IN_ORDER_TO_VB_COMMA)
docs/ce/howto/trigger-directly.mdx
[uncategorized] ~7-~7: A comma might be missing here.
Context: ...os this can get expensive. But in some scenarios e.g. small projects that have no need f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ce/reference/digger.yml.mdx
[typographical] ~171-~171: After the expression ‘for example’ a comma is usually used.
Context: ...rom | this can be used for secrets. For example you set a secret from some secret manag...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~171-~171: You might be missing the article “an” here.
Context: ...secret manager (e.g. GitHub secrets) as environment variable and the remap it to another va...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/ce/securing-digger/external-provider.mdx
[typographical] ~15-~15: Consider adding a comma here.
Context: ... details and to engage in the discussion please take a look at this GitHub issue: https...
(PLEASE_COMMA)
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ... and to engage in the discussion please take a look at this GitHub issue: https://gith...
(TAKE_A_LOOK)
docs/ce/self-host/deploy-binary.mdx
[grammar] ~83-~83: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/self-host/deploy-docker-compose.mdx
[grammar] ~94-~94: Did you mean the possessive pronoun “its”?
Context: ... select the repositories. From here on it's the same steps as in the [Quickstart](/...
(IT_S_ITS)
docs/ce/self-host/self-host-on-azure.mdx
[uncategorized] ~69-~69: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Now you can visit /GitHub/setup endpoint and you will be greeted with this setup wiz...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~75-~75: A comma might be missing here.
Context: ...-05-26at19.00.38.png) After successful installation you will see all the GitHub credentials...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~95-~95: A comma might be missing here.
Context: ...GitHub app into the org and if all goes well we should see a succesful installation ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~95-~95: It appears that the past participle should be used here.
Context: ...tion (pick the test repo where you have terraform in)! ![Screenshot2025 05 26at19 58 03...
(HAVE_PART_AGREEMENT)
docs/ee/ee-setup.mdx
[uncategorized] ~19-~19: A comma might be missing here.
Context: ... After you have the orchestrator up and running you will need a repo to test digger on....
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~21-~21: A comma might be missing here.
Context: ...r_workflow.yml` Once you have the repo ready you need to install it to the image. So...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/fips-140.mdx
[style] ~7-~7: Consider a more concise word here.
Context: ...mpiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~7-~7: A comma might be missing here.
Context: ...S140 enabled. In order to enable it for GitHub follow these steps: - For the backend ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/gitlab-support.mdx
[uncategorized] ~5-~5: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prere...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~10-~10: A comma might be missing here.
Context: ...icense key. If you don't have a license key please [contact us](https://calendly.co...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~13-~13: Possible missing preposition found.
Context: ...om User Preferences > Access Tokens ### Install the digger EE orchestrator: You need t...
(AI_HYDRA_LEO_MISSING_TO)
[misspelling] ~15-~15: This word is normally spelled with a hyphen.
Context: ...ion steps are the same as the steps in self hosting docker with ...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~19-~19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...kgs/container/digger_backend - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~21-~21: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...from prerequisite step) ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~29-~29: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~46-~46: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~47-~47: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as "abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~48-~48: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents" are selected for Trigger events. Finally you can save. ### Create digger pipel...
(RB_LY_COMMA)
[uncategorized] ~51-~51: You might be missing the article “a” here.
Context: ...nts. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~53-~53: Possible missing comma found.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .GitLab-ci.yml file in th...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~53-~53: Consider adding a comma here.
Context: ...i.yml file in the root of your file. In this you need to create a script which downl...
(TO_THAT_COMMA)
[style] ~104-~104: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...st. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~104-~104: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~112-~112: You might be missing the article “the” here.
Context: ...ly.png) ## Repo allowlist You can set DIGGER_REPO_ALLOW_LIST env variable on ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/ee/gitlab.mdx
[uncategorized] ~6-~6: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...S and GitLab pipelines as a CI backend. Currently this is an EE feature only. ### Prereq...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~16-~16: This word is normally spelled with a hyphen.
Context: ...n steps are the same as the steps in [self hosting docker](https://docs.digger.dev/self-...
(EN_COMPOUNDS_SELF_HOSTING)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ences: - For the docker image you will need to use the ee image: https://github.com/di...
(REP_NEED_TO_VB)
[style] ~19-~19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ..., v0.6.5 as of this guide)** - You will need to include the license key environment var...
(REP_NEED_TO_VB)
[style] ~21-~21: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ables - For GitLab CI configuration you need to specify the following environment varia...
(REP_NEED_TO_VB)
[uncategorized] ~30-~30: A comma might be missing here.
Context: ...git.mydomain.com/api/v4 ``` Other than that if you follow the steps in the self hos...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~30-~30: This word is normally spelled with a hyphen.
Context: ...han that if you follow the steps in the self hosting guide you should end up with the orches...
(EN_COMPOUNDS_SELF_HOSTING)
[uncategorized] ~44-~44: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...In the repo where you are interested to integrate with digger you need to set up a webhoo...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ...re you are interested to integrate with digger you need to set up a webhook pointing t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~44-~44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...interested to integrate with digger you need to set up a webhook pointing to your digge...
(REP_NEED_TO_VB)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...name. Go to Settings > Webhooks and add digger host name. Set the secret token as “abc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~44-~44: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...vents” are selected for Trigger events. Finally you can save. ### Create digger pipeli...
(RB_LY_COMMA)
[uncategorized] ~46-~46: You might be missing the article “a” here.
Context: ...ents. Finally you can save. ### Create digger pipeline in your GitLab repo To create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~48-~48: A comma might be missing here.
Context: ...in your GitLab repo To create a GitLab pipeline you can use a .gitlab-ci.yml file in th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~48-~48: Consider adding a comma here.
Context: ...file in the root of your repository. In this you need to create a script which downl...
(TO_THAT_COMMA)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...need to create a script which downloads Digger binary and invokes it, the purpose here...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~48-~48: You might be missing the article “a” here.
Context: ... externally. Here is an example of such file: ```jsx variables: DIGGER_LICENSE_KE...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~93-~93: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...t. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
[uncategorized] ~93-~93: A comma might be missing here.
Context: ...lso trigger and also perform a plan. If successful the job will comment back the plan as f...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/ee/multi-github.mdx
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...lti Tenant GitHub Connections" --- In CE version of digger during onboarding you...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...Hub Connections" --- In CE version of digger during onboarding you can use a wizard ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...s" --- In CE version of digger during onboarding you can use a wizard to create [a GitHu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... using environment variables. In larger orgs there could be a requirement that there...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...at there are multiple orgs representing department. The GitHub app created is installable ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... created is installable on a single org only unless it is published. For enterprise ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~8-~8: Possible missing comma found.
Context: ... unless it is published. For enterprise usecases publishing to GitHub marketplace is not...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~8-~8: Use a comma after an introductory phrase.
Context: ... to GitHub marketplace is not feasible. For this reason we introduced multi-tenant GitHub app v...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~9-~9: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s allow multiple app connections per org but it also makes it fully ui-based and the...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~14-~14: A comma might be missing here.
Context: ...rerequisite As a prerequisite for this step you need to have already set the enviro...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... set up multi org connections: In your backend you can visit /GitHub/connections and i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~26-~26: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ackend you can visit /GitHub/connections and it will show you a screen like below !...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~30-~30: It appears that a comma is missing.
Context: ...e/multi-tenant-GitHub.png) Within this screen you can see your current connections an...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~31-~31: The preposition ‘of’ seems more likely in this position.
Context: ... app" to follow the wizard for creation in your org. Ensure that the button on Git...
(AI_HYDRA_LEO_REPLACE_IN_OF)
[uncategorized] ~31-~31: You might be missing the article “the” here.
Context: ... in your org. Ensure that the button on GitHub side says "create in diggerhq" so it is...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~31-~31: Insert a comma before quoting reported speech: “says, "”…
Context: .... Ensure that the button on GitHub side says "create in diggerhq" so it is installed i...
(SAID_COMMA_SPEECH)
[uncategorized] ~32-~32: A comma is probably missing here.
Context: ...stalled in the right organisation. Upon success you will be redirected back to the same...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~32-~32: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...will be redirected back to the same page and you should see that connection in the t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~33-~33: A period might be missing here.
Context: ...ink to install that connection from the table Important: its important to instal...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~35-~35: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ...nnection from the table Important: its important to install using the link in ...
(AI_HYDRA_LEO_CPT_ITS_ITIS)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ortant to install using the link in the table since an additional "state" parameter i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Consider a more concise word here.
Context: ...er is passed containing app ID metadata in order to verify the app on callback. If you atte...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ... to install the created app from GitHub directly it will lead to an error.
(AI_HYDRA_LEO_MISSING_COMMA)
docs/readme/pricing.mdx
[grammar] ~43-~43: Consider using “All Digger” or “All of the Digger”.
Context: ...ich parts of Digger are Open Source?** All of Digger is open source, even the enterprise edi...
(ALL_MOST_SOME_OF_NOUN)
[style] ~44-~44: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...ub App) and Digger community edition is exactly the same, the difference is only where it is hos...
(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Security Check
🔇 Additional comments (6)
docs/ce/reference/digger.yml.mdx (1)
249-250: LGTM – heading matches new capitalisationNo other issues spotted.
docs/ce/self-host/deploy-docker-compose.mdx (1)
94-95: Lower-case path & minor grammar tweakDocs routes are case-sensitive on most hosts—capitalising “GitHub” may 404.
-From here on it's the same steps as in the [Quickstart](/ce/getting-started/GitHub-actions-+-aws): +From here on, follow the same steps as in the [Quickstart](/ce/getting-started/github-actions-+-aws):docs/ee/gitlab.mdx (1)
93-97: Verify that the renamed images actually exist on diskThe docs now reference
/images/ee/GitLab-1.pngand/images/ee/GitLab-2.png.
If the underlying files are still lowercase (gitlab-1.png…) the images will 404 on case-sensitive filesystems/CDNs.docs/ce/self-host/deploy-binary.mdx (1)
83-84: Check that the target file path really uses capital “GitHub”The link now points to
/ce/getting-started/GitHub-actions-+-aws.
The docs repo historically used lowercase paths; a mismatched case will break the hyperlink on most hosting setups.docs/ce/self-host/self-host-on-azure.mdx (2)
69-70: Endpoint path likely lowercase on the backendUnless the server routes are case-insensitive,
/GitHub/setupshould be/github/setup.-Now you can visit /GitHub/setup endpoint ... +Now you can visit /github/setup endpoint ...
58-60: Fix duplicatedsecret:block and incorrect indentationThe YAML now contains two nested
secret:objects, which makes the example invalid.
Consolidate them into one and keep keys at the same depth:- secret: - useExistingSecret: false - existingSecretName: "" - - httpBasicAuthUsername: "admin" - httpBasicAuthPassword: "abc123" - bearerAuthToken: "salkfjadslkfj" # You should generate - hostname: "<https://mo-digger-test.ngrok.app>" - secret: - useExistingSecret: false - existingSecretName: "" - ... + secret: + useExistingSecret: false + existingSecretName: "" + httpBasicAuthUsername: "admin" + httpBasicAuthPassword: "abc123" + bearerAuthToken: "salkfjadslkfj" # generate your own + hostname: "<https://mo-digger-test.ngrok.app>" + githubOrg: "diggerhq" # replace with your org + githubAppID: "" + githubAppClientID: "" + githubAppClientSecret: "" + githubAppKeyFile: "" # base64 encoded + githubWebhookSecret: ""Likely an incorrect or invalid review comment.
| The GitHub action JWT token includes alot of useful fields such as `ref`, `sha`, `runner_environment` etc. however it is | ||
| challenging to write an AWS trust policy to match for these fields since only `aud` and `sub` fields are supported. Using cognito | ||
| identity it is possible to remap the fields into principal tags which allows them to be matched in the trust policy. More information | ||
| about this is in this article: https://catnekaise.github.io/github-actions-abac-aws/cognito-identity/. | ||
| about this is in this article: https://catnekaise.GitHub.io/GitHub-actions-abac-aws/cognito-identity/. | ||
|
|
There was a problem hiding this comment.
Restore lowercase URL & clean up “alot” / punctuation
Using capitals inside a GitHub Pages domain can break the link. Also, “alot” → “a lot”, and commas added for readability.
-The GitHub action JWT token includes alot of useful fields such as `ref`, `sha`, `runner_environment` etc. however it is
+The GitHub Actions JWT token includes a lot of useful claims such as `ref`, `sha`, and `runner_environment`; however, it is
...
-about this is in this article: https://catnekaise.GitHub.io/GitHub-actions-abac-aws/cognito-identity/.
+about this is in this article: https://catnekaise.github.io/github-actions-abac-aws/cognito-identity/.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The GitHub action JWT token includes alot of useful fields such as `ref`, `sha`, `runner_environment` etc. however it is | |
| challenging to write an AWS trust policy to match for these fields since only `aud` and `sub` fields are supported. Using cognito | |
| identity it is possible to remap the fields into principal tags which allows them to be matched in the trust policy. More information | |
| about this is in this article: https://catnekaise.github.io/github-actions-abac-aws/cognito-identity/. | |
| about this is in this article: https://catnekaise.GitHub.io/GitHub-actions-abac-aws/cognito-identity/. | |
| The GitHub Actions JWT token includes a lot of useful claims such as `ref`, `sha`, and `runner_environment`; however, it is | |
| challenging to write an AWS trust policy to match for these fields since only `aud` and `sub` fields are supported. Using cognito | |
| identity it is possible to remap the fields into principal tags which allows them to be matched in the trust policy. More information | |
| about this is in this article: https://catnekaise.github.io/github-actions-abac-aws/cognito-identity/. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...ref, sha, runner_environment etc. however it is challenging to write an AWS trust...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~46-~46: A comma might be missing here.
Context: ...sha, runner_environment` etc. however it is challenging to write an AWS trust po...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🤖 Prompt for AI Agents
In docs/ce/howto/project-level-roles.mdx around lines 46 to 50, fix the URL by
converting the GitHub Pages domain to all lowercase to prevent broken links,
change "alot" to "a lot", and add commas for better readability in the sentence
describing the GitHub action JWT token fields.
|
Hi @gecube thanks for this! can you please resolve conflicts before merge? |
Signed-off-by: George Gaál <[email protected]>
gecube
force-pushed
the
github-gitlab-naming
branch
from
2f5c672 to
17a4cf0
Compare
|
@motatoes sorry for the delay. I hope that I fixed. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/ee/gitlab-support.mdx (1)
29-31: Still references a GitHub app in a GitLab guideThe sentence tells users they should have a “GitHub app successfully installed”, which is irrelevant – in the GitLab flow we only need a webhook.
This was already highlighted in a previous review but remains unfixed.-along with a GitHub app successfully installed. The repo you wish to try with digger should be installed onto the orchestrator. +with the GitLab webhook configured for your test repository and the orchestrator running.
🧹 Nitpick comments (14)
docs/ee/fips-140.mdx (2)
7-7: Fix typos and tighten wording for claritySpelling (“seperately”), punctuation, and flow can be improved without altering meaning.
-as of version v0.6.101 digger backend and cli are both compiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps: +As of version v0.6.101, the Digger backend and CLI are compiled separately with FIPS 140 enabled. To enable it for GitHub, follow these steps:
19-19: Capitalize FIPS and streamline the sentenceMinor wording/grammar polish and consistent casing for “FIPS-enabled”.
-If you are using GitLab or other VCS then just ensure that you are downloading the fips enabled binary which is suffixed with '_fips' +If you are using GitLab or another VCS, ensure that you download the FIPS-enabled binary, which is suffixed with `_fips`.docs/ce/howto/apply-requirements.mdx (1)
13-14: Fix typos & tighten wording
mergability→mergeability- Replace the filler phrase “in the meantime” with the shorter “meanwhile”.
-cause the "mergability" check to conflict if you set the digger/apply check as required on GitHub. We are working on a fix and in the meantime you have an option to turn off the mergability check +cause the "mergeability" check to conflict if you set the digger/apply check as required on GitHub. We are working on a fix and, meanwhile, you can turn off the mergeability checkdocs/ce/securing-digger/external-provider.mdx (1)
15-15: Streamline phrasing“take a look at” is wordy; consider the leaner “see”.
-please take a look at this GitHub issue: +please see this GitHub issue:docs/ce/features/private-runners.mdx (2)
7-7: Refine sentence & proper brand name
- Capitalise “Actions”.
- Drop the intensifier “very”.
-While digger does not natively support k8s agents it is very easy to do it indirectly using GitHub actions runners. +While Digger does not natively support k8s agents, it is easy to achieve this indirectly with GitHub Actions runners.
19-20: Minor wording polishConsider plural-singular agreement and brand casing:
-With GitHub specifically there is good support for [self-hosted runners] ... +GitHub provides first-class support for [self-hosted runners] ...docs/ce/howto/store-plans-in-a-bucket.mdx (1)
5-6: Correct tool capitalisation & concise wording-### GitHub -Digger can use GitHub Artifacts to store `terraform plan` outputs. In order to enable it you can set the following argument in digger_workflow.yml: +### GitHub +Digger can use GitHub Artifacts to store `Terraform plan` outputs. To enable it, add the following argument in `digger_workflow.yml`:docs/ee/multi-github.mdx (3)
6-9: Fix compound word & marketplace capitalisation-In larger orgs there could be a requirement that there are multiple orgs representing department. The GitHub app created is installable on a single org only unless it is published. -For enterprise usecases publishing to GitHub marketplace is not feasible. For this reason we introduced multi-tenant GitHub app via connections. +In larger organisations, departments may be split across multiple GitHub orgs. A GitHub App can be installed in only one org unless it is published. +For enterprise use cases, publishing to the GitHub Marketplace is not feasible, so we introduced a multi-tenant GitHub App via connections.
26-32: Grammar & clarity-In your backend you can visit /GitHub/connections and it will show you a screen like below +In the backend UI, visit `/GitHub/connections`; you will see a screen like the one below-Within this screen you can see your current connections and also create your connections to an org. Type in your GitHub org in the -text box and click on "set up GitHub app" to follow the wizard for creation in your org. Ensure that the button on GitHub side says "create in diggerhq" +On this page you can view existing connections or create a new one. Enter your GitHub organisation name in the text box and click **Set up GitHub App** to launch the wizard. Ensure the GitHub side button reads **Create in diggerhq**
35-36: Apostrophe & brevity-**Important**: its important to install using the link in the table since an additional "state" parameter is passed containing app ID metadata in order to +**Important**: it’s important to install using the link in the table because an additional `state` parameter containing App ID metadata is passed todocs/ee/gitlab-support.mdx (2)
5-5: Capitalize the product name for brand consistencyThroughout the docs we use “Digger” as a proper noun, but this line starts with lowercase “digger”.
Keeping the casing consistent avoids brand-dilution and looks more professional.-You can use digger with GitLab as your VCS and GitLab pipelines as a CI backend. Currently this is an EE feature only. +You can use Digger with GitLab as your VCS and GitLab pipelines as a CI backend. Currently this is an EE feature only.
102-104: Remove the duplicate “also” for smoother readingMinor wording fix.
-Your GitLab should also trigger and also perform a plan. +Your GitLab should also trigger and perform a plan.docs/ee/gitlab.mdx (2)
12-12: Use title-case in the navigation pathGitLab’s UI labels are “User Preferences” → “Access Tokens”. Capitalising them helps users follow the path exactly.
-A personal GitLab access token. This can be created from user preferences > access tokens +A personal GitLab access token. This can be created from User Preferences > Access Tokens
93-93: Drop the second “also”Same wording issue as in the support doc.
-Your GitLab should also trigger and also perform a plan. +Your GitLab should also trigger and perform a plan.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
action.yml(1 hunks)docs/ce/azure-specific/azure.mdx(2 hunks)docs/ce/features/opa-policies.mdx(1 hunks)docs/ce/features/plan-preview.mdx(1 hunks)docs/ce/features/private-runners.mdx(2 hunks)docs/ce/gcp/federated-oidc-access.mdx(3 hunks)docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx(1 hunks)docs/ce/getting-started/github-actions-+-aws.mdx(2 hunks)docs/ce/getting-started/github-actions-and-gcp.mdx(3 hunks)docs/ce/getting-started/gitlab-pipelines-+-aws.mdx(1 hunks)docs/ce/howto/apply-requirements.mdx(1 hunks)docs/ce/howto/auto-merge.mdx(1 hunks)docs/ce/howto/generate-projects.mdx(1 hunks)docs/ce/howto/project-level-roles.mdx(1 hunks)docs/ce/howto/store-plans-in-a-bucket.mdx(1 hunks)docs/ce/howto/trigger-directly.mdx(1 hunks)docs/ce/reference/action-inputs.mdx(1 hunks)docs/ce/reference/digger.yml.mdx(3 hunks)docs/ce/securing-digger/external-provider.mdx(2 hunks)docs/ce/securing-digger/spec-signing.mdx(2 hunks)docs/ce/self-host/deploy-binary.mdx(4 hunks)docs/ce/self-host/deploy-docker-compose.mdx(4 hunks)docs/ce/self-host/deploy-docker.mdx(4 hunks)docs/ce/self-host/deploy-helm.mdx(1 hunks)docs/ce/self-host/self-host-on-azure.mdx(6 hunks)docs/ee/buildkite.mdx(3 hunks)docs/ee/drift-detection.mdx(1 hunks)docs/ee/ee-setup.mdx(1 hunks)docs/ee/fips-140.mdx(2 hunks)docs/ee/gitlab-support.mdx(4 hunks)docs/ee/gitlab.mdx(3 hunks)docs/ee/multi-github.mdx(2 hunks)docs/mint.json(1 hunks)docs/readme/feedback.mdx(1 hunks)docs/readme/introduction.mdx(1 hunks)docs/readme/pricing.mdx(3 hunks)docs/team/getting-started/gha-aws.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (12)
- docs/ce/reference/digger.yml.mdx
- docs/ee/drift-detection.mdx
- docs/ce/getting-started/github-actions-+-aws.mdx
- docs/team/getting-started/gha-aws.mdx
- docs/ce/gcp/federated-oidc-access.mdx
- docs/ce/azure-specific/azure.mdx
- docs/ee/buildkite.mdx
- docs/ce/self-host/deploy-docker.mdx
- docs/ce/self-host/deploy-helm.mdx
- docs/ce/getting-started/gitlab-pipelines-+-aws.mdx
- docs/ce/getting-started/github-actions-and-gcp.mdx
- docs/readme/pricing.mdx
🚧 Files skipped from review as they are similar to previous changes (17)
- docs/ce/reference/action-inputs.mdx
- docs/ce/features/plan-preview.mdx
- docs/readme/introduction.mdx
- docs/ee/ee-setup.mdx
- docs/ce/gcp/setting-up-gcp-+-gh-actions.mdx
- docs/ce/features/opa-policies.mdx
- docs/ce/howto/generate-projects.mdx
- docs/readme/feedback.mdx
- docs/mint.json
- docs/ce/securing-digger/spec-signing.mdx
- action.yml
- docs/ce/howto/auto-merge.mdx
- docs/ce/self-host/deploy-binary.mdx
- docs/ce/self-host/deploy-docker-compose.mdx
- docs/ce/howto/trigger-directly.mdx
- docs/ce/self-host/self-host-on-azure.mdx
- docs/ce/howto/project-level-roles.mdx
🧰 Additional context used
🧠 Learnings (7)
docs/ce/features/private-runners.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
docs/ce/howto/apply-requirements.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ce/howto/store-plans-in-a-bucket.mdx (2)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ce/securing-digger/external-provider.mdx (3)
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ee/gitlab-support.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
docs/ee/gitlab.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
docs/ee/multi-github.mdx (1)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
🪛 LanguageTool
docs/ce/features/private-runners.mdx
[style] ~7-~7: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...s not natively support k8s agents it is very easy to do it indirectly using GitHub action...
(EN_WEAK_ADJECTIVE)
docs/ce/howto/apply-requirements.mdx
[style] ~13-~13: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ... on GitHub. We are working on a fix and in the meantime you have an option to turn off the merg...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
docs/ce/howto/store-plans-in-a-bucket.mdx
[style] ~6-~6: Consider a more concise word here.
Context: ...acts to store terraform plan outputs. In order to enable it you can set the following arg...
(IN_ORDER_TO_PREMIUM)
docs/ce/securing-digger/external-provider.mdx
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ... and to engage in the discussion please take a look at this GitHub issue: https://gith...
(TAKE_A_LOOK)
docs/ee/fips-140.mdx
[grammar] ~7-~7: Ensure spelling is correct
Context: ...igger backend and cli are both compiled seperately with FIPS140 enabled. In order to enabl...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~7-~7: Consider a more concise word here.
Context: ...mpiled seperately with FIPS140 enabled. In order to enable it for GitHub follow these steps...
(IN_ORDER_TO_PREMIUM)
[grammar] ~19-~19: Ensure spelling is correct
Context: ... 'true' ``` If you are using GitLab or other VCS then just ensure that you are downloadi...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/ee/gitlab-support.mdx
[style] ~104-~104: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...st. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
docs/ee/gitlab.mdx
[style] ~93-~93: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...t. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
docs/ee/multi-github.mdx
[style] ~35-~35: Consider a more concise word here.
Context: ...er is passed containing app ID metadata in order to verify the app on callback. If you atte...
(IN_ORDER_TO_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Security Check
🔇 Additional comments (2)
docs/ce/securing-digger/external-provider.mdx (1)
5-5: Consistent capitalisationGood catch on “Terraform” and “GitHub Actions”. 👍
No further issues found.docs/ee/multi-github.mdx (1)
2-3: Title looks goodTitle now matches branding; no issues.
Signed-off-by: George Gaál <[email protected]>
Signed-off-by: George Gaál <[email protected]>
Signed-off-by: George Gaál <[email protected]>
Signed-off-by: George Gaál <[email protected]>
Signed-off-by: George Gaál <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/ee/gitlab-support.mdx (3)
5-5: Capitalize “Pipelines” and tighten the copyMinor branding/style polish.
-You can use digger with GitLab as your VCS and GitLab pipelines as a CI backend. Currently this is an EE feature only. +You can use Digger with GitLab as your VCS and GitLab Pipelines as the CI backend. Currently this is an EE-only feature.
53-55: Replace “root of your file” → “root of your repository”The current wording is confusing; there is no “root of your file”.
-To create a GitLab pipeline you can use a .gitlab-ci.yml file in the root of your file. In this you need to +To create a GitLab pipeline you can add a `.gitlab-ci.yml` file to the root of your repository. In this file you need to
104-104: Remove duplicate “also” for smoother reading-GitLab should also trigger and also perform a plan. If successful the job will comment back the plan as follows: +GitLab should trigger and perform a plan. If successful, the job will comment back the plan as follows:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/ce/features/private-runners.mdx(2 hunks)docs/ce/howto/apply-requirements.mdx(1 hunks)docs/ce/securing-digger/external-provider.mdx(2 hunks)docs/ee/fips-140.mdx(2 hunks)docs/ee/gitlab-support.mdx(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/ce/securing-digger/external-provider.mdx
- docs/ee/fips-140.mdx
- docs/ce/features/private-runners.mdx
- docs/ce/howto/apply-requirements.mdx
🧰 Additional context used
🧠 Learnings (1)
docs/ee/gitlab-support.mdx (2)
Learnt from: motatoes
PR: diggerhq/digger#1855
File: backend/controllers/github.go:768-774
Timestamp: 2024-12-17T12:34:41.545Z
Learning: In the Digger project, the `DIGGER_GENERATION_WEBHOOK_SECRET` environment variable is optional and may be an empty string, so validation for its presence is not required in the code.
Learnt from: motatoes
PR: diggerhq/digger#1873
File: .github/workflows/libs_test.yml:20-24
Timestamp: 2025-01-20T23:08:29.386Z
Learning: In the Digger project's test workflows, both Terraform and OpenTofu setups are required to make the tests work correctly. The workflow uses Terraform v1.5.5 and OpenTofu v1.8.5.
🪛 LanguageTool
docs/ee/gitlab-support.mdx
[style] ~104-~104: You’ve already used the word ‘also’ once in your sentence, so using it again may be redundant.
Context: ...st. Your GitLab should also trigger and also perform a plan. If successful the job will comm...
(REDUNDANT_FILLER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Build
- GitHub Check: Security Check
🔇 Additional comments (1)
docs/ee/gitlab-support.mdx (1)
106-108: Verify image path casingThe images reference
/images/GitLab/...; depending on the hosting platform this path may be case-sensitive. Confirm that the actual directory and filenames use the same “GitLab” casing to avoid broken images.
Summary by CodeRabbit