From b6da7b960c9d2a210b51a6d665bd53c9c77fadd4 Mon Sep 17 00:00:00 2001 From: Ismael Martinez Ramos Date: Tue, 9 Jun 2026 08:24:34 +0100 Subject: [PATCH] docs: use shell-portable env var names in install examples Most shells cannot export a variable whose name contains a dot, so the GITHUB.BASE_URL / OPENAI.KEY style examples in the install docs broke when copied into a shell or a GitHub Actions env: block. Switch the examples to the double-underscore form (GITHUB__BASE_URL), which Dynaconf accepts identically and which the .env example already uses. Fixes #2310. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/docs/installation/github.md | 4 ++-- docs/docs/installation/locally.md | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/installation/github.md b/docs/docs/installation/github.md index 09c1b3d1af..e9b33881fd 100644 --- a/docs/docs/installation/github.md +++ b/docs/docs/installation/github.md @@ -546,13 +546,13 @@ For more detailed configuration options, see: ### Action for GitHub enterprise server !!! tip "" - To use the action with a GitHub enterprise server, add an environment variable `GITHUB.BASE_URL` with the API URL of your GitHub server. + To use the action with a GitHub enterprise server, add an environment variable `GITHUB__BASE_URL` with the API URL of your GitHub server. For example, if your GitHub server is at `https://github.mycompany.com`, add the following to your workflow file: ```yaml env: # ... previous environment values - GITHUB.BASE_URL: "https://github.mycompany.com/api/v3" + GITHUB__BASE_URL: "https://github.mycompany.com/api/v3" ``` --- diff --git a/docs/docs/installation/locally.md b/docs/docs/installation/locally.md index 63e1ede70e..ec322a60bb 100644 --- a/docs/docs/installation/locally.md +++ b/docs/docs/installation/locally.md @@ -12,48 +12,48 @@ To invoke a tool (for example `review`), you can run PR-Agent directly from the - For GitHub: ```bash - docker run --rm -it -e OPENAI.KEY= -e GITHUB.USER_TOKEN= pragent/pr-agent:latest --pr_url review + docker run --rm -it -e OPENAI__KEY= -e GITHUB__USER_TOKEN= pragent/pr-agent:latest --pr_url review ``` If you are using GitHub enterprise server, you need to specify the custom url as variable. For example, if your GitHub server is at `https://github.mycompany.com`, add the following to the command: ```bash - -e GITHUB.BASE_URL=https://github.mycompany.com/api/v3 + -e GITHUB__BASE_URL=https://github.mycompany.com/api/v3 ``` - For GitLab: ```bash - docker run --rm -it -e OPENAI.KEY= -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN= pragent/pr-agent:latest --pr_url review + docker run --rm -it -e OPENAI__KEY= -e CONFIG__GIT_PROVIDER=gitlab -e GITLAB__PERSONAL_ACCESS_TOKEN= pragent/pr-agent:latest --pr_url review ``` If you have a dedicated GitLab instance, you need to specify the custom url as variable: ```bash - -e GITLAB.URL= + -e GITLAB__URL= ``` - For BitBucket: ```bash - docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN pragent/pr-agent:latest --pr_url= review + docker run --rm -it -e CONFIG__GIT_PROVIDER=bitbucket -e OPENAI__KEY=$OPENAI_API_KEY -e BITBUCKET__BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN pragent/pr-agent:latest --pr_url= review ``` - For Gitea: ```bash - docker run --rm -it -e OPENAI.KEY= -e CONFIG.GIT_PROVIDER=gitea -e GITEA.PERSONAL_ACCESS_TOKEN= pragent/pr-agent:latest --pr_url review + docker run --rm -it -e OPENAI__KEY= -e CONFIG__GIT_PROVIDER=gitea -e GITEA__PERSONAL_ACCESS_TOKEN= pragent/pr-agent:latest --pr_url review ``` If you have a dedicated Gitea instance, you need to specify the custom url as variable: ```bash - -e GITEA.URL= + -e GITEA__URL= ``` -For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values. +For other git providers, update `CONFIG__GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values. ### Utilizing environment variables