Skip to content

Commit 249b3df

Browse files
feat: badge polished
1 parent 96b8158 commit 249b3df

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
**面向 NXP i.MX6ULL 的嵌入式 Linux 开发工坊 —— 从工具链到驱动的完整学习路径**
1313

1414
[![CI](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/actions/workflows/ci-build.yml/badge.svg)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/actions/workflows/ci-build.yml)
15-
[![Release](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=Release&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/releases/latest)
15+
[![Tag](https://img.shields.io/github/v/tag/Awesome-Embedded-Learning-Studio/imx-forge?sort=semver&style=flat-square&label=Tag&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/tags)
16+
[![Latest Stable](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=latest%20stable&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/releases/latest)
1617
[![License](https://img.shields.io/badge/License-MIT-orange?style=flat-square)](LICENSE)
1718
[![Contributors](https://img.shields.io/github/contributors/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/graphs/contributors)
1819
[![Docker](https://img.shields.io/badge/Docker-supported%20%EF%83%8B-blue?style=flat-square)](docker/README.md)

document/release/versioning-strategy.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ MAJOR 只用于不兼容变化。
167167
正式发布示例:
168168

169169
```text
170-
当前最新 tag: v1.0.0
171-
release_type=patch -> v1.0.1
170+
当前最新 tag: v1.0.3
171+
release_type=patch -> v1.0.4
172172
release_type=minor -> v1.1.0
173173
release_type=major -> v2.0.0
174174
```
@@ -268,21 +268,23 @@ IMX-Forge vX.Y.Z
268268

269269
## 7. README 版本 Banner
270270

271-
在 README.md badge 区域追加版本 badge,使用 shields.io 显示最新 GitHub Release 版本
271+
在 README.md badge 区域追加版本 badge,使用 shields.io 同时显示最新 GitHub tag 和最新 GitHub Release
272272

273273
```markdown
274-
[![Release](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=Release&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/releases/latest)
274+
[![Tag](https://img.shields.io/github/v/tag/Awesome-Embedded-Learning-Studio/imx-forge?sort=semver&style=flat-square&label=Tag&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/tags)
275+
[![Latest Stable](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=latest%20stable&color=blue)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/releases/latest)
275276
```
276277

277278
插入位置建议在 CI badge 之后:
278279

279280
```markdown
280281
[![CI](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/actions/workflows/ci-build.yml/badge.svg)](...)
281-
[![Release](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=Release&color=blue)](...)
282+
[![Tag](https://img.shields.io/github/v/tag/Awesome-Embedded-Learning-Studio/imx-forge?sort=semver&style=flat-square&label=Tag&color=blue)](...)
283+
[![Latest Stable](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square&label=latest%20stable&color=blue)](...)
282284
[![License](https://img.shields.io/badge/License-MIT-orange?style=flat-square)](LICENSE)
283285
```
284286

285-
由于 GitHub Release 与 Docker 镜像发布已经解耦,README badge 展示的是最新 GitHub Release,不一定等于最新 git tag 或 Docker 镜像版本。这是有意设计:Release 用于公告稳定节点,Docker 镜像可按需更频繁更新
287+
由于 GitHub Release 与 Docker 镜像发布已经解耦,Tag badge 展示最新 git tag,避免 PATCH 版本只打 tag、不创建 GitHub Release 时页面版本号滞后;latest stable badge 展示最新 GitHub Release,用于公告稳定节点
286288

287289
---
288290

0 commit comments

Comments
 (0)