From b15e8bf05fcf02bc2dce7f598404d1e376f7a28c Mon Sep 17 00:00:00 2001 From: Arkadiusz Szarama Date: Mon, 13 Oct 2025 14:05:17 +0200 Subject: [PATCH 1/4] feat: update docs related to GitHub scaffolder usage --- README.relay.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.relay.md b/README.relay.md index 86757c7..b52aa29 100644 --- a/README.relay.md +++ b/README.relay.md @@ -71,18 +71,21 @@ Generally the naming works like: ### Environment Variables Summary -| Integration | Environment Variables | -|----------------|---------------------------------------------------------------------------------------------------------------------| -| **GitHub** | `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_TOKEN` | -| **GitHub Hosted** | `GITHUB_API=https://myapp.github.com/api/v3`, `GITHUB_GRAPHQL=https://myapp.github.com/api/graphql`, `GITHUB_TOKEN` | -| **GitHub App** | Arg `-s app`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID` | -| **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` | -| **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` | -| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONARQUBE_TOKEN` | -| **Bitbucket Cloud** | `BITBUCKET_API=https://api.bitbucket.org`, `BITBUCKET_TOKEN` | -| **Bitbucket Hosted** | `BITBUCKET_API=https://bitbucket.mycompany.com`, `BITBUCKET_USERNAME`, `BITBUCKET_PASSWORD` | -| **Jira** | `JIRA_API=https://jira.mycompany.com`, `JIRA_USERNAME`, `JIRA_TOKEN` | -| **Jira Bearer/Cloud** | Arg `-s bearer`, `JIRA_API=https://mycompany.atlassian.com`, `JIRA_TOKEN` | +| Integration | Environment Variables | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **GitHub** | `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_TOKEN` | +| **GitHub Hosted** | `GITHUB=https://myapp.github.com`, `GITHUB_API=https://myapp.github.com/api/v3`, `GITHUB_GRAPHQL=https://myapp.github.com/api/graphql`, `GITHUB_TOKEN` | +| **GitHub App** | Arg `-s app`, `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID`, `GITHUB_TOKEN` ( | +| **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` | +| **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` | +| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONARQUBE_TOKEN` | +| **Bitbucket Cloud** | `BITBUCKET_API=https://api.bitbucket.org`, `BITBUCKET_TOKEN` | +| **Bitbucket Hosted** | `BITBUCKET_API=https://bitbucket.mycompany.com`, `BITBUCKET_USERNAME`, `BITBUCKET_PASSWORD` | +| **Jira** | `JIRA_API=https://jira.mycompany.com`, `JIRA_USERNAME`, `JIRA_TOKEN` | +| **Jira Bearer/Cloud** | Arg `-s bearer`, `JIRA_API=https://mycompany.atlassian.com`, `JIRA_TOKEN` | + +> [!NOTE] +> `GITHUB_TOKEN` in GitHub App is the [installation access token](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation) and is needed only for [scaffolder](https://docs.cortex.io/streamline/workflows/scaffolder) purposes. ## How it works From ff5650f8e8fed1687f8f3fb8c25350a3d2a1400f Mon Sep 17 00:00:00 2001 From: Arkadiusz Szarama Date: Mon, 13 Oct 2025 14:08:07 +0200 Subject: [PATCH 2/4] feat: update docs related to GitHub scaffolder usage --- README.relay.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.relay.md b/README.relay.md index b52aa29..f0e6a3b 100644 --- a/README.relay.md +++ b/README.relay.md @@ -71,18 +71,18 @@ Generally the naming works like: ### Environment Variables Summary -| Integration | Environment Variables | -|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **GitHub** | `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_TOKEN` | -| **GitHub Hosted** | `GITHUB=https://myapp.github.com`, `GITHUB_API=https://myapp.github.com/api/v3`, `GITHUB_GRAPHQL=https://myapp.github.com/api/graphql`, `GITHUB_TOKEN` | -| **GitHub App** | Arg `-s app`, `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID`, `GITHUB_TOKEN` ( | -| **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` | -| **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` | -| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONARQUBE_TOKEN` | -| **Bitbucket Cloud** | `BITBUCKET_API=https://api.bitbucket.org`, `BITBUCKET_TOKEN` | -| **Bitbucket Hosted** | `BITBUCKET_API=https://bitbucket.mycompany.com`, `BITBUCKET_USERNAME`, `BITBUCKET_PASSWORD` | -| **Jira** | `JIRA_API=https://jira.mycompany.com`, `JIRA_USERNAME`, `JIRA_TOKEN` | -| **Jira Bearer/Cloud** | Arg `-s bearer`, `JIRA_API=https://mycompany.atlassian.com`, `JIRA_TOKEN` | +| Integration | Environment Variables | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **GitHub** | `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_TOKEN` | +| **GitHub Hosted** | `GITHUB=https://myapp.github.com`, `GITHUB_API=https://myapp.github.com/api/v3`, `GITHUB_GRAPHQL=https://myapp.github.com/api/graphql`, `GITHUB_TOKEN` | +| **GitHub App** | Arg `-s app`, `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID`, `GITHUB_TOKEN` | +| **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` | +| **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` | +| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONARQUBE_TOKEN` | +| **Bitbucket Cloud** | `BITBUCKET_API=https://api.bitbucket.org`, `BITBUCKET_TOKEN` | +| **Bitbucket Hosted** | `BITBUCKET_API=https://bitbucket.mycompany.com`, `BITBUCKET_USERNAME`, `BITBUCKET_PASSWORD` | +| **Jira** | `JIRA_API=https://jira.mycompany.com`, `JIRA_USERNAME`, `JIRA_TOKEN` | +| **Jira Bearer/Cloud** | Arg `-s bearer`, `JIRA_API=https://mycompany.atlassian.com`, `JIRA_TOKEN` | > [!NOTE] > `GITHUB_TOKEN` in GitHub App is the [installation access token](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation) and is needed only for [scaffolder](https://docs.cortex.io/streamline/workflows/scaffolder) purposes. From d31cec98e3f84f23e0b59f092401c28f19753237 Mon Sep 17 00:00:00 2001 From: Arkadiusz Szarama Date: Mon, 13 Oct 2025 14:11:53 +0200 Subject: [PATCH 3/4] feat: update docs --- README.relay.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.relay.md b/README.relay.md index f0e6a3b..6d44c9c 100644 --- a/README.relay.md +++ b/README.relay.md @@ -36,8 +36,9 @@ services: image: ghcr.io/cortexapps/cortex-axon-agent:latest env_file: .env env: - - GITHUB_API=api.github.com - - GITHUB_GRAPHQL=api.github.com/graphql + - GITHUB=https://github.com + - GITHUB_API=https://api.github.com + - GITHUB_GRAPHQL=https://api.github.com/graphql command: [ "relay", "-i", "github", @@ -51,6 +52,7 @@ services: Note if you are using a private Github App installation (subtype `app`), you'll need to set the `GITHUB_API` and `GITHUB_GRAPHQL` to your internal Github API endpoints, for example: ``` +GITHUB=https://github.mycompany.com GITHUB_API=https://github.mycompany.com/api/v3 GITHUB_GRAPHQL=https://github.mycompany.com/api/graphql ``` @@ -74,7 +76,7 @@ Generally the naming works like: | Integration | Environment Variables | |----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **GitHub** | `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_TOKEN` | -| **GitHub Hosted** | `GITHUB=https://myapp.github.com`, `GITHUB_API=https://myapp.github.com/api/v3`, `GITHUB_GRAPHQL=https://myapp.github.com/api/graphql`, `GITHUB_TOKEN` | +| **GitHub Hosted** | `GITHUB=https://github.mycompany.com`, `GITHUB_API=https://github.mycompany.com/api/v3`, `GITHUB_GRAPHQL=https://github.mycompany.com/api/graphql`, `GITHUB_TOKEN` | | **GitHub App** | Arg `-s app`, `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID`, `GITHUB_TOKEN` | | **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` | | **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` | From 0fd84ac6e729d253b47b30ac936ff26f52e52973 Mon Sep 17 00:00:00 2001 From: Arkadiusz Szarama Date: Mon, 13 Oct 2025 14:17:30 +0200 Subject: [PATCH 4/4] feat: update docs --- README.relay.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.relay.md b/README.relay.md index 6d44c9c..6a55952 100644 --- a/README.relay.md +++ b/README.relay.md @@ -146,6 +146,7 @@ relay: subtype: # optional, can be blank, see table above for options alias: alias for configuration from Cortex env: + GITHUB: "https://github.com" GITHUB_API: "https://api.github.com" GITHUB_GRAPHQL_API: "https://api.github.com/graphql" verbose: false # set to true to enable verbose logging