如何在GitLab README.md/徽章中自动展示并更新项目依赖库版本？

Great question! Let’s break down practical, GitLab-native solutions for both of your needs—no manual edits or external tools required:

The core idea here is to automate extracting dependency versions from your source files, inject them into your README, and commit the changes automatically via GitLab CI/CD. Here’s a step-by-step example tailored to Node.js (easily adaptable for Python, Java, etc.):

1. Add version placeholders to your README.md
   Insert comment-marked placeholders where you want versions to show up—this lets the script know exactly where to update:

   ## Project Dependencies
   - Express: <!-- DEP_VERSION: express -->
   - React: <!-- DEP_VERSION: react -->
   

2. Set up a CI job to handle updates
   Add this job to your .gitlab-ci.yml file. It pulls versions from your package.json, replaces the placeholders, and commits the updated README back to your repo:

   update-dependency-versions:
     stage: deploy
     image: node:latest
     script:
       # Extract version numbers from package.json
       EXPRESS_VERSION=$(node -p "require('./package.json').dependencies.express")
       REACT_VERSION=$(node -p "require('./package.json').dependencies.react")
       # Replace placeholders in README
       sed -i "s/<!-- DEP_VERSION: express -->/$EXPRESS_VERSION/g" README.md
       sed -i "s/<!-- DEP_VERSION: react -->/$REACT_VERSION/g" README.md
       # Configure git for CI commits
       git config --global user.name "GitLab CI Bot"
       git config --global user.email "ci-bot@your-project.com"
       # Commit and push (skip CI to avoid infinite loops)
       git add README.md
       git commit -m "Auto-update dependency versions [skip ci]"
       git push origin $CI_COMMIT_BRANCH
     only:
       - main # Run on your main branch
       - schedules # Optional: Add a weekly schedule to catch indirect updates
   

   For Python projects, swap the version extraction step with something like:

   FLASK_VERSION=$(grep -E "^Flask==" requirements.txt | cut -d'=' -f3)
   

If you don’t want to commit changes to your README at all, you have two solid GitLab-native options:

Option 1: Dynamic README via GitLab Pages #

Generate a live-updated README that pulls dependency versions at build time:

• Create a README-template.md file with the same placeholders as above.
• Add a CI job that injects the latest version numbers into the template, saves it as README.md, and publishes it to GitLab Pages.
• Link to your Pages-hosted README from your repo’s main page, or set Pages to serve it as the root content.

Option 2: Custom Dependency Version Badges #

GitLab lets you add custom badges that pull live version data directly from your repo’s CI artifacts. Here’s how to set it up without external tools:

1. Add a CI job to generate badge SVGs
   This job extracts versions and creates simple, self-contained SVG badges:

   generate-dependency-badges:
     stage: build
     image: alpine:latest
     script:
       # Extract Flask version (adjust for your stack)
       FLASK_VERSION=$(grep -E "^Flask==" requirements.txt | cut -d'=' -f3)
       # Generate a custom SVG badge
       echo "<svg xmlns='http://www.w3.org/2000/svg' width='100' height='20'>
         <rect width='60' height='20' fill='#555'/>
         <rect x='60' width='40' height='20' fill='#2ecc71'/>
         <text x='30' y='15' fill='white' text-anchor='middle' font-family='sans-serif' font-size='12'>Flask</text>
         <text x='80' y='15' fill='white' text-anchor='middle' font-family='sans-serif' font-size='12'>$FLASK_VERSION</text>
       </svg>" > flask-badge.svg
     artifacts:
       paths:
         - flask-badge.svg
       expire_in: 1 week
   

2. Add the badge to your README and project settings

   • In your README, add this line (replace placeholders with your project details):

     ![Flask Version](https://gitlab.com/<your-username>/<your-project>/-/jobs/artifacts/main/raw/flask-badge.svg?job=generate-dependency-badges)
     

   • Optional: Go to your project’s Settings > General > Badges to add the badge to your repo’s main page for extra visibility.

Every time your CI runs, the badge pulls the latest version directly from your source files—no manual edits or README commits needed.

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