fix: 规范化示例文件和文档中的格式,优化参数描述,提升可读性

This commit is contained in:
Lyda
2025-08-21 18:19:02 +08:00
parent d17dea4ca0
commit 1949a48d96
3 changed files with 25 additions and 25 deletions

View File

@@ -15,24 +15,24 @@
## 输入参数 ## 输入参数
| 参数名 | 描述 | 必需 | 默认值 | | 参数名 | 描述 | 必需 | 默认值 |
| -------------------------- | ------------------------------ | ---- | ------- | | -------------------- | -------------------------------- | ---- | ------- |
| `version-prefix` | 版本前缀,用于匹配版本标签或分支 | 否 | `v` | | `version-prefix` | 版本前缀,用于匹配版本标签或分支 | 否 | `v` |
| `use-latest-version` | 在非版本触发时是否使用最新版本 | 否 | `false` | | `use-latest-version` | 在非版本触发时是否使用最新版本 | 否 | `false` |
## 输出参数 ## 输出参数
| 参数名 | 描述 | 示例值 | | 参数名 | 描述 | 示例值 |
| ------------------------------ | ---------------------------- | ------------------------------- | | -------------------------- | -------------------------- | ------------------------------- |
| `ref-type` | 引用类型 | `tag``branch` | | `ref-type` | 引用类型 | `tag``branch` |
| `ref-name` | 引用名称 | `v1.2.3``main``feature/xxx` | | `ref-name` | 引用名称 | `v1.2.3``main``feature/xxx` |
| `is-version-trigger` | 是否为版本触发 | `true``false` | | `is-version-trigger` | 是否为版本触发 | `true``false` |
| `trigger-version` | 触发的版本号(标准化格式) | `v1.2.3` | | `trigger-version` | 触发的版本号(标准化格式) | `v1.2.3` |
| `version-with-dash` | 版本号,点替换为横线 | `v1-2-3` | | `version-with-dash` | 版本号,点替换为横线 | `v1-2-3` |
| `trigger-source` | 触发源 | `tag``branch` | | `trigger-source` | 触发源 | `tag``branch` |
| `full-ref` | 完整的 Git 引用 | `refs/tags/v1.2.3` | | `full-ref` | 完整的 Git 引用 | `refs/tags/v1.2.3` |
| `latest-version` | 仓库中的最新版本号 | `v1.2.3` | | `latest-version` | 仓库中的最新版本号 | `v1.2.3` |
| `latest-version-with-dash` | 最新版本号,点替换为横线 | `v1-2-3` | | `latest-version-with-dash` | 最新版本号,点替换为横线 | `v1-2-3` |
## 环境变量 ## 环境变量
@@ -67,7 +67,7 @@ jobs:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 # 必需:获取完整历史以获取所有标签 fetch-depth: 0 # 必需:获取完整历史以获取所有标签
- name: 获取版本信息 - name: 获取版本信息
id: version-info id: version-info
@@ -94,7 +94,7 @@ jobs:
### 使用最新版本功能 ### 使用最新版本功能
```yaml ````yaml
- name: 获取版本信息(启用最新版本) - name: 获取版本信息(启用最新版本)
id: version-info id: version-info
uses: ./trigger-version uses: ./trigger-version
@@ -119,7 +119,7 @@ jobs:
uses: actions/xgj/trigger-version@v1 uses: actions/xgj/trigger-version@v1
with: with:
version-prefix: "release-" version-prefix: "release-"
``` ````
### 完整的 CI/CD 流程 ### 完整的 CI/CD 流程

View File

@@ -187,7 +187,7 @@ runs:
echo "trigger_source=$TRIGGER_SOURCE" >> $GITHUB_OUTPUT echo "trigger_source=$TRIGGER_SOURCE" >> $GITHUB_OUTPUT
echo "latest_version=$LATEST_VERSION" >> $GITHUB_OUTPUT echo "latest_version=$LATEST_VERSION" >> $GITHUB_OUTPUT
echo "latest_version_with_dash=$LATEST_VERSION_WITH_DASH" >> $GITHUB_OUTPUT echo "latest_version_with_dash=$LATEST_VERSION_WITH_DASH" >> $GITHUB_OUTPUT
# 输出摘要信息 # 输出摘要信息
echo "" echo ""
echo "=== 版本信息摘要 ===" echo "=== 版本信息摘要 ==="

View File

@@ -1,9 +1,9 @@
name: Latest Version Demo name: Latest Version Demo
on: on:
push: push:
branches: [ main, develop ] branches: [main, develop]
pull_request: pull_request:
branches: [ main ] branches: [main]
jobs: jobs:
show-version-info: show-version-info:
@@ -12,13 +12,13 @@ jobs:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 # 获取完整历史,确保能获取所有标签 fetch-depth: 0 # 获取完整历史,确保能获取所有标签
- name: Get Version Info - name: Get Version Info
id: version id: version
uses: ./trigger-version uses: ./trigger-version
with: with:
version-prefix: 'v' version-prefix: "v"
use-latest-version: true use-latest-version: true
- name: Display Version Information - name: Display Version Information
@@ -43,10 +43,10 @@ jobs:
run: | run: |
echo "使用最新版本进行部署: ${{ steps.version.outputs.latest-version }}" echo "使用最新版本进行部署: ${{ steps.version.outputs.latest-version }}"
echo "镜像标签: myapp:${{ steps.version.outputs.latest-version-with-dash }}" echo "镜像标签: myapp:${{ steps.version.outputs.latest-version-with-dash }}"
# 示例:构建 Docker 镜像 # 示例:构建 Docker 镜像
# docker build -t myapp:${{ steps.version.outputs.latest-version-with-dash }} . # docker build -t myapp:${{ steps.version.outputs.latest-version-with-dash }} .
# 示例:设置 Kubernetes 部署 # 示例:设置 Kubernetes 部署
# kubectl set image deployment/myapp container=myapp:${{ steps.version.outputs.latest-version-with-dash }} # kubectl set image deployment/myapp container=myapp:${{ steps.version.outputs.latest-version-with-dash }}