Local Dev/Debug with GHES and public github.com

[bhundven]

How are you running Renovate?

Self-hosted Renovate

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

GitHub Enterprise Server

Please tell us more about your question or problem

I'm trying to develop and debug a renovate config for a specific repository on a pre-existing repository in our Github Enterprise Server, and would like to develop and debug locally without committing changes. I found that the renovate cli supports dry-run, which is exactly what I want.

The problem is that I'm not sure how to get the cli to work properly. Some dependencies are on our local GHES while others are in public github.com. I'm providing the endpoint and token for our GHES on the cli, but it still says GitHub token is required for some dependencies. Some of those dependencies are on the local GHES... so why are they not being discovered? And then how do I provide a token for the public github.com?

If I try to change the provider to local, how do I specify PATs for GHES and github.com, and map dependencies to the right places?

See logs:

Logs (if relevant)

Logs

renovate.json5:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "config:recommended",
    "docker:enableMajor",
    "github>aquaproj/aqua-renovate-config",
    "github>aquaproj/aqua-renovate-config:installer-script(install-aqua\\.sh)",
    "github>aquaproj/aqua-renovate-config:file(^aqua/.*\\.ya?ml$)"
  ],
  "enabledManagers": [
    "dockerfile",
    "github-actions",
    "pre-commit",
    "pip_requirements",
    "custom.regex"
  ],
  "labels": [
    "renovate:{{depName}}",
    "renovate:{{depName}}/{{newVersion}}",
    "datasource:{{datasource}}"
  ],
  "major": {
    "automerge": false
  },
  "automerge": false,
  "prHourlyLimit": 10,
  "prConcurrentLimit": 10,
  "branchConcurrentLimit": 20,
  "pre-commit": {"enabled": true},
  "packageRules": [
    {
      "matchCategories": ["python"],
      "enabled": true
    },
    {
      "additionalBranchPrefix": "{{packageFileDir}}-",
      "commitMessageSuffix": "({{packageFileDir}})",
      "matchPackageNames": ["/.*/"]
    }
  ]
}

provider=github

$ renovate --platform=github --repository-cache=reset --dry-run=full --endpoint='https://git.GHES-LOCAL.local/api/v3/' --token="$(gh auth token --hostname git.GHES-LOCAL.local)" org/repo
 INFO: Repository started (repository=org/repo)
       "renovateVersion": "39.47.1"
 INFO: Dependency extraction complete (repository=org/repo, baseBranch=master)
       "stats": {
         "managers": {
           "dockerfile": {"fileCount": 1, "depCount": 1},
           "github-actions": {"fileCount": 4, "depCount": 22},
           "pip_requirements": {"fileCount": 1, "depCount": 8},
           "pre-commit": {"fileCount": 1, "depCount": 6},
           "regex": {"fileCount": 6, "depCount": 32}
         },
         "total": {"fileCount": 13, "depCount": 69}
       }
 WARN: GitHub token is required for some dependencies (repository=org/repo)
       "githubDeps": [
         "actions/checkout",
         "synced-actions/custom-docker-login",
         "synced-actions/metadata-action",
         "synced-actions/setup-qemu-action",
         "synced-actions/docker-setup-buildx-action",
         "synced-actions/docker-build-push-action",
         "synced-actions/hadolint-action",
         "synced-actions/action-shellcheck",
         "synced-actions/yamllint-github-action",
         "synced-actions/release-please-action",
         "actions/stale",
         "pre-commit/pre-commit-hooks",
         "hadolint/hadolint",
         "adrienverge/yamllint",
         "rhysd/actionlint",
         "renovatebot/pre-commit-hooks",
         "igorshubovych/markdownlint-cli",
         "cli/cli",
         "getsops/sops",
         "iamhsa/pkenv",
         "tofuutils/tenv",
         "mikefarah/yq",
         "argoproj/argo-cd",
         "istio/istio/istioctl",
         "terraform-linters/tflint",
         "kubernetes-sigs/kustomize",
         "derailed/k9s",
         "Azure/kubelogin",
         "helm/helm",
         "kubernetes/kubectl",
         "open-policy-agent/opa",
         "aquaproj/aqua-registry",
         "aquaproj/aqua-installer"
       ]
 INFO: DRY-RUN: Would ensure Dependency Dashboard (repository=org/repo)
       "title": "Dependency Dashboard"
 INFO: DRY-RUN: Would save repository cache. (repository=org/repo)
 INFO: Repository finished (repository=org/repo)
       "cloned": true,
       "durationMs": 7506
 INFO: Renovate was run at log level "info". Set LOG_LEVEL=debug in environment variables to see extended debug logs.

provider=local

$ renovate --platform=local --repository-cache=reset --dry-run=full --endpoint='https://git.GHES-LOCAL.local/api/v3/' --token="$(gh auth token --hostname git.GHES-LOCAL.local)"
 INFO: Repository started (repository=local)
       "renovateVersion": "39.47.1"
 INFO: Dependency extraction complete (repository=local)
       "stats": {
         "managers": {
           "dockerfile": {"fileCount": 1, "depCount": 1},
           "github-actions": {"fileCount": 4, "depCount": 22},
           "pip_requirements": {"fileCount": 1, "depCount": 8},
           "pre-commit": {"fileCount": 1, "depCount": 6},
           "regex": {"fileCount": 6, "depCount": 32}
         },
         "total": {"fileCount": 13, "depCount": 69}
       }
 WARN: GitHub token is required for some dependencies (repository=local)
       "githubDeps": [
         "actions/checkout",
         "synced-actions/custom-docker-login",
         "synced-actions/metadata-action",
         "synced-actions/setup-qemu-action",
         "synced-actions/docker-setup-buildx-action",
         "synced-actions/docker-build-push-action",
         "synced-actions/hadolint-action",
         "synced-actions/action-shellcheck",
         "synced-actions/yamllint-github-action",
         "synced-actions/release-please-action",
         "actions/stale",
         "pre-commit/pre-commit-hooks",
         "hadolint/hadolint",
         "adrienverge/yamllint",
         "rhysd/actionlint",
         "renovatebot/pre-commit-hooks",
         "igorshubovych/markdownlint-cli",
         "cli/cli",
         "getsops/sops",
         "iamhsa/pkenv",
         "tofuutils/tenv",
         "mikefarah/yq",
         "argoproj/argo-cd",
         "istio/istio/istioctl",
         "terraform-linters/tflint",
         "kubernetes-sigs/kustomize",
         "derailed/k9s",
         "Azure/kubelogin",
         "helm/helm",
         "kubernetes/kubectl",
         "open-policy-agent/opa",
         "aquaproj/aqua-registry",
         "aquaproj/aqua-installer"
       ]
 WARN: Error updating branch (repository=local, branch=renovate/ansible-11.x)
       "err": {
         "message": "Cannot sync git when platform=local",
         "stack": "Error: Cannot sync git when platform=local\n    at syncGit (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/util/git/index.ts:383:11)\n    at getFile (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/util/git/index.ts:939:9)\n    at getFileContent (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/update/branch/get-updated.ts:35:32)\n    at getUpdatedPackageFiles (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/update/branch/get-updated.ts:121:38)\n    at processBranch (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/update/branch/index.ts:479:47)\n    at writeUpdates (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/process/write.ts:166:17)\n    at update (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/process/extract-update.ts:213:11)\n    at Object.renovateRepository (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/repository/index.ts:89:19)\n    at attributes.repository (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/global/index.ts:206:11)\n    at start (/Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/workers/global/index.ts:191:7)\n    at /Users/bhundven/.nvm/versions/node/v22.11.0/lib/node_modules/renovate/lib/renovate.ts:19:22"
       }
 INFO: DRY-RUN: Would ensure Dependency Dashboard (repository=local)
       "title": "Dependency Dashboard"
 INFO: DRY-RUN: Would save repository cache. (repository=local)
 INFO: Repository finished (repository=local)
       "cloned": undefined,
       "durationMs": 1369
 INFO: Renovate was run at log level "info". Set LOG_LEVEL=debug in environment variables to see extended debug logs.

[bhundven]

Dependencies under actions/ and synced-actions/ are hosted on our local GHES server using action sync.

[synack-badamson]

I'm in the same situation and wanted to test local dry-runs.

I fought with this same thing so much tonight. This is as close as I got. It's not perfect and breaks a couple of managers? But it at least partially works... I was able to debug against GHES.

export RENOVATE_TOKEN=$(gh auth token -h myghes.com -u myuser)
export RENOVATE_DETECT_GLOBAL_MANAGER_CONFIG=true
export LOG_LEVEL="debug"
export GITHUB_COM_TOKEN=$(gh auth token -h github.com)
export RENOVATE_FORCE='{"redisUrl": null, "extends": ["config:recommended"], "defaultRegistryUrls": ["https://myghes.com", "https://github.com"]}'
export RENOVATE_HOST_RULES="[{\"matchHost\": \"myghes.com\", \"token\": \"$RENOVATE_TOKEN\"}]"

renovate --dry-run=full --platform=local

We should be able to limit defaultRegistryUrls to the github-only packages with a packageRule, but for the life of me it would just simply ignore it. Using RENOVATE_FORCE is the only thing that finally got it to even look at GHES.