自托管Renovate(Github Actions)访问AWS Code Artifact报错排查

一、当前报错的直接原因 #

你使用了--config=renovate-config.json参数，但Renovate CLI并不支持--config这个选项，正确的指定配置文件的参数是--config-file，或者通过环境变量RENOVATE_CONFIG_FILE来指定。这就是导致error: unknown option '--config=renovate-config.json'的根本原因。

二、修复当前配置的步骤 #

1. 修正Renovate运行命令 #

把GitHub Actions里的Run Renovate步骤替换为：

- name: Run Renovate
  run: renovate --config-file=renovate-config.json
  env:
    CODEARTIFACT_AUTH_TOKEN: ${{ secrets.CODEARTIFACT_AUTH_TOKEN }}

或者用环境变量的方式更规范：

- name: Run Renovate
  run: renovate
  env:
    RENOVATE_CONFIG_FILE: renovate-config.json
    CODEARTIFACT_AUTH_TOKEN: ${{ secrets.CODEARTIFACT_AUTH_TOKEN }}

2. 完善Renovate配置，支持AWS Code Artifact认证 #

当前的renovate-config.json只配置了仓库地址，但AWS Code Artifact需要携带认证令牌才能访问。需要添加hostRules来配置认证信息：

{
  "platform": "github",
  "endpoint": "https://api.github.com",
  "token": "${{ secrets.GITHUB_TOKEN }}",
  "repositories": ["githubuser/reponame"],
  "hostRules": [
    {
      "matchHost": "domain-123456789.d.codeartifact.us-east-1.amazonaws.com",
      "username": "aws",
      "password": "${{ env.CODEARTIFACT_AUTH_TOKEN }}"
    }
  ],
  "packageRules": [
    {
      "matchDatasources": ["maven"],
      "registryUrls": [
        "https://domain-123456789.d.codeartifact.us-east-1.amazonaws.com/maven/repo/"
      ]
    }
  ]
}

注：AWS Code Artifact的认证用户名固定为aws，密码就是你的CODEARTIFACT_AUTH_TOKEN。

3. 优化token替换步骤 #

原来的sed命令可能存在环境变量解析问题，建议直接通过环境变量传递token，去掉sed替换步骤：

- name: Run Renovate
  run: renovate --config-file=renovate-config.json
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    CODEARTIFACT_AUTH_TOKEN: ${{ secrets.CODEARTIFACT_AUTH_TOKEN }}

同时修改renovate-config.json里的token字段为"${{ env.GITHUB_TOKEN }}"即可。

三、更简洁的替代实现方式：使用官方Renovate Action #

自己安装npm包的方式容易遇到版本问题，推荐使用官方的renovatebot/github-action，它已封装了Renovate的运行环境，配置更简单：

完整的GitHub Actions配置（renovate.yml） #

name: Renovate
on:
  schedule:
    - cron: '*/10 * * * *'
  workflow_dispatch: # 支持手动触发

jobs:
  renovate:
    runs-on: ubuntu-latest
    steps:
      - name: Run Renovate
        uses: renovatebot/github-action@v39
        with:
          configurationFile: renovate-config.json
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          CODEARTIFACT_AUTH_TOKEN: ${{ secrets.CODEARTIFACT_AUTH_TOKEN }}

对应的renovate-config.json #

{
  "platform": "github",
  "repositories": ["githubuser/reponame"],
  "hostRules": [
    {
      "matchHost": "domain-123456789.d.codeartifact.us-east-1.amazonaws.com",
      "username": "aws",
      "password": "${{ env.CODEARTIFACT_AUTH_TOKEN }}"
    }
  ],
  "packageRules": [
    {
      "matchDatasources": ["maven"],
      "registryUrls": [
        "https://domain-123456789.d.codeartifact.us-east-1.amazonaws.com/maven/repo/"
      ]
    }
  ]
}

注：官方Action会自动处理GitHub API的endpoint，可去掉endpoint配置。

四、额外注意事项 #

• AWS Code Artifact令牌有效期：默认令牌有效期为12小时，若使用临时生成的令牌，需确保Action运行时令牌有效。
• 权限配置：确保GITHUB_TOKEN拥有仓库读写权限，默认的secrets.GITHUB_TOKEN在公共仓库中权限足够，私有仓库可能需额外配置。
• Cron频率：测试阶段可用每10分钟一次的频率，正式环境建议改为每天或每几小时运行一次，避免频繁请求。

内容的提问来源于stack exchange，提问作者Faisal Shani