本地Gitlab实例中README.md动态变量配置求助

方案一：通过GitLab CI/CD自动生成动态README.md #

这种方式会在代码推送时自动替换模板中的占位符，生成包含实时仓库名和分支名的README.md并提交到仓库，用户访问Web界面时就能看到最新内容。

步骤1：创建README模板文件 #

在仓库根目录新建 README.template.md，用占位符标记需要替换的内容：

# {{REPO_NAME}}

当前分支：{{BRANCH_NAME}}

---

这里是项目的详细介绍内容...

步骤2：编写CI/CD配置文件 #

在仓库根目录创建 .gitlab-ci.yml，添加以下流水线任务：

update_dynamic_readme:
  stage: deploy
  only:
    - main  # 可根据需求修改为需要自动更新的分支，如改为`branches`匹配所有分支
  script:
    # 使用sed命令替换模板中的占位符为GitLab内置变量
    - sed -e "s/{{REPO_NAME}}/$CI_PROJECT_NAME/g" -e "s/{{BRANCH_NAME}}/$CI_COMMIT_BRANCH/g" README.template.md > README.md
    # 配置Git提交身份
    - git config --global user.name "GitLab CI/CD Bot"
    - git config --global user.email "ci-bot@your-local-gitlab.com"
    # 提交并推送更新后的README.md
    - git add README.md
    - git commit -m "Update README with repo and branch info [skip ci]"
    - git push "https://gitlab-ci-token:${CI_JOB_TOKEN}@${CI_REPOSITORY_URL#*@}" HEAD:$CI_COMMIT_BRANCH

关键配置说明 #

• $CI_PROJECT_NAME：GitLab内置变量，自动获取当前仓库名称
• $CI_COMMIT_BRANCH：GitLab内置变量，自动获取当前流水线运行的分支名称
• [skip ci]：提交信息中添加该标记，避免触发新的流水线循环，防止无限执行
• 权限设置：如果目标分支是受保护分支，需要在项目设置的「CI/CD」→「流水线权限」中，开启「允许CI_JOB_TOKEN推送至受保护分支」

方案二：直接在README.md中使用GitLab内置变量（局限性说明） #

GitLab Web界面渲染README.md时，不会自动解析替换环境变量，因此无法直接在README.md中写$CI_PROJECT_NAME来显示仓库名。如果不想通过CI/CD修改仓库文件，可考虑以下折中方式：

• 在README.md中手动标注变量说明，如：当前仓库：{{仓库名称}} | 当前分支：{{分支名称}}，但需要用户自行替换，无法自动更新
• 若使用Git Pages部署项目，可通过静态站点生成工具（如Jekyll、Hugo）在构建时注入GitLab变量生成页面，但这仅适用于Git Pages场景，不适用于仓库默认的README页面

内容的提问来源于stack exchange，提问作者F.Hazi