Dynamic Badges Action 使用教程

Dynamic Badges Action 使用教程

dynamic-badges-action This action allows you to create badges for your README.md with shields.io which may change with every commit. To do this, this action does not need to push anything to your repository! 项目地址: https://gitcode.com/gh_mirrors/dy/dynamic-badges-action

1. 项目的目录结构及介绍

dynamic-badges-action/
├── action.yml
├── README.md
├── src/
│   ├── main.js
│   └── utils.js
└── test/
    └── test.js

• action.yml: 项目的配置文件，定义了GitHub Actions的工作流程。
• README.md: 项目的说明文档，包含了项目的介绍、使用方法和示例。
• src/: 项目的源代码目录，包含了主要的JavaScript文件。
  • main.js: 项目的主入口文件，负责处理动态徽章的生成。
  • utils.js: 包含了一些辅助函数，用于处理徽章的生成逻辑。
• test/: 项目的测试代码目录，包含了测试用例。
  • test.js: 测试文件，用于验证项目的功能。

2. 项目的启动文件介绍

项目的启动文件是 src/main.js。这个文件是整个项目的入口点，负责处理动态徽章的生成逻辑。它通过读取配置文件 action.yml 中的参数，生成相应的徽章，并将其输出到指定的位置。

3. 项目的配置文件介绍

项目的配置文件是 action.yml。这个文件定义了GitHub Actions的工作流程，包括如何触发、如何执行以及如何生成徽章。以下是配置文件的主要内容：

name: 'Dynamic Badges'
description: 'Create badges for your README.md with shields.io which may change with every commit.'
inputs:
  auth:
    description: 'Authentication token for GitHub'
    required: true
  gistID:
    description: 'ID of the Gist where the badge data will be stored'
    required: true
  filename:
    description: 'Name of the file where the badge data will be stored'
    required: true
  label:
    description: 'Label for the badge'
    required: true
  message:
    description: 'Message for the badge'
    required: true
  valColorRange:
    description: 'Color range for the badge value'
    required: true
  maxColorRange:
    description: 'Maximum value for the color range'
    required: true
  minColorRange:
    description: 'Minimum value for the color range'
    required: true
runs:
  using: 'node20'
  main: 'src/main.js'

• name: 定义了Action的名称。
• description: 描述了Action的功能。
• inputs: 定义了Action的输入参数，包括认证令牌、Gist ID、文件名、徽章标签、消息、颜色范围等。
• runs: 定义了Action的执行环境（使用Node.js 20）和主入口文件（src/main.js）。

通过这个配置文件，用户可以自定义徽章的生成逻辑，并将其集成到GitHub Actions的工作流程中。

dynamic-badges-action This action allows you to create badges for your README.md with shields.io which may change with every commit. To do this, this action does not need to push anything to your repository! 项目地址: https://gitcode.com/gh_mirrors/dy/dynamic-badges-action