Skip to content

Commit 763bdfe

Browse files
chore(release): align v1.0.0 lightweight release docs (#63)
* chore(release): align v1.0.0 lightweight release docs - unify v1.0.0 release wording across README, Docker docs, and CI docs - add release notes and changelog under dedicated directories - document verified SD and UUU+UMS eMMC boot baselines - fix tutorial navigation links and expand driver tutorial index - remove unused release workflow and ci-release docs - make ShellCheck failures block PR checks * ci: fix the shellcheck
1 parent 687a455 commit 763bdfe

19 files changed

Lines changed: 187 additions & 216 deletions

.github/workflows/ci-pr.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ jobs:
4343
run: |
4444
sudo apt-get update -qq
4545
sudo apt-get install -y shellcheck
46-
# 检查所有 shell 脚本
47-
find ./scripts -type f \( -name "*.sh" -o -name "*.bash" \) -exec shellcheck -x {} + 2>&1 || true
46+
# 检查所有 shell 脚本;只用 error 级别阻断 PR,warning/info 后续专项清理
47+
find ./scripts -type f \( -name "*.sh" -o -name "*.bash" \) -exec shellcheck --severity=error -x {} +
4848
4949
# Job 3: 配置验证
5050
configs:

.github/workflows/ci-release.yml

Lines changed: 0 additions & 64 deletions
This file was deleted.

QUICK_START.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ arm-none-linux-gnueabihf-gcc --version
151151

152152
快速开始后,建议按以下顺序学习:
153153

154-
1. [Docker 教程](document/tutorial/docker/README.md) —— 熟悉开发环境
154+
1. [Docker 教程](document/tutorial/docker/) —— 熟悉开发环境
155155
2. [工具链教程](document/tutorial/start/) —— 理解交叉编译
156156
3. [U-Boot 教程](document/tutorial/uboot/) —— Bootloader 基础
157157
4. [内核教程](document/tutorial/kernel/) —— Linux 内核开发

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ IMX-Forge 支持 **Docker** 和 **WSL2 + Docker** 两种开发环境:
7777

7878
#### 方式一:直接拉取镜像(最简单)
7979

80-
我们提供预构建的 Docker 镜像,包含完整的开发环境。正式版本标签从 `v0.1.0` 开始;历史 `v0.5` 仅作为路线图里程碑编号保留。
80+
我们提供预构建的 Docker 镜像,包含完整的开发环境。`v1.0.0` 是首个轻量可用版本,重点完成正点原子阿尔法 i.MX6ULL 的构建、镜像、烧录、启动闭环;历史 `v0.5` 仅作为路线图里程碑编号保留。
8181

8282
| 标签 | 说明 | 适用场景 |
8383
|------|------|----------|
8484
| `latest` | 稳定版本 | 日常开发推荐 |
8585
| `preview` | 预览版本 | 测试新功能 |
86-
| `v0.1.0`| 版本号 | 锁定特定版本 |
86+
| `v1.0.0`| 版本号 | 锁定特定版本 |
8787

8888
```bash
8989
git clone --recurse-submodules https://github.com/Awesome-Embedded-Learning-Studio/imx-forge.git
@@ -98,7 +98,7 @@ docker run -it --rm -v $(pwd):/workspace ghcr.io/awesome-embedded-learning-studi
9898

9999
使用特定版本:
100100
```bash
101-
docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:v0.1.0
101+
docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:v1.0.0
102102
```
103103

104104
> **镜像说明**: 基于 Ubuntu 24.04,预装 ARM GNU Toolchain 15.2.rel1 及所有开发依赖,截至文档更新时约 2GB(实际大小可能存在波动)。详见 [Docker 发布文档](document/ci/docker-publish.md)
@@ -113,6 +113,14 @@ docker run -it --rm -v $(pwd):/workspace imx-forge:latest
113113
./scripts/release-all.sh
114114
```
115115

116+
`release-all.sh` 默认生成 eMMC 镜像;发布或回归 SD/eMMC 双介质时推荐:
117+
118+
```bash
119+
./scripts/release-all.sh --boot-media both
120+
```
121+
122+
v1.0.0 的 SD 卡启动与 UUU + UMS eMMC 启动流程,已由仓库主作者 CharlieChen114514 在正点原子阿尔法 i.MX6ULL 开发板上完成实验验证。
123+
116124
> **国内用户加速**: 如果 ghcr.io 拉取较慢,可配置 Docker 镜像加速,详见 [Docker 文档](docker/README.md#国内用户加速)
117125
118126
### 🪟 WSL2 + Docker(Windows 用户首选)
@@ -134,7 +142,7 @@ docker run -it --rm -v $(pwd):/workspace imx-forge:latest
134142
| 2️⃣ | [U-Boot](document/tutorial/uboot) | U-Boot 原理、编译、移植、Logo 定制 ||
135143
| 3️⃣ | [内核开发](document/tutorial/kernel) | 设备树、内核配置、驱动开发、网络启动 ||
136144
| 4️⃣ | [Rootfs](document/tutorial/rootfs) | BusyBox、inittab、NFS 挂载、应用集成 ||
137-
| 5️⃣ | [驱动开发](document/tutorial/driver) | 字符设备、设备树、pinctrl/gpio 子系统 | 正在持续更新 |
145+
| 5️⃣ | [驱动开发](document/tutorial/driver) | 字符设备、设备树、pinctrl/gpio、platform、key/input 子系统 | ✅ 持续扩展 |
138146
| 6️⃣ | [实战演练](document/tutorial/practical) | 完整系统构建与调试 ||
139147

140148
---

changelog/CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Changelog
2+
3+
## v1.0.0 - 轻量首版
4+
5+
IMX-Forge v1.0.0 是首个轻量可用版本,目标是让正点原子阿尔法 i.MX6ULL 开发板完成从开发环境到系统启动的主线闭环。
6+
7+
### 已验证闭环
8+
9+
- Docker/WSL2 开发环境入口与一键 release 构建流程。
10+
- U-Boot、Linux Kernel、BusyBox、RootFS 与完整镜像装配。
11+
- SD 卡镜像 `imx6ull-aes-sd.img``mmc 0``root=/dev/mmcblk0p2`
12+
- eMMC 镜像 `imx6ull-aes-emmc.img``mmc 1``root=/dev/mmcblk1p2`
13+
- SD 卡启动与 UUU + UMS eMMC 启动已由仓库主作者 CharlieChen114514 在正点原子阿尔法 i.MX6ULL 开发板上实验通过。
14+
15+
### 本地可生成产物
16+
17+
- `out/release-latest/uboot/u-boot-dtb.imx`
18+
- `out/release-latest/linux/arch/arm/boot/zImage`
19+
- `out/release-latest/linux/arch/arm/boot/dts/nxp/imx/imx6ull-aes.dtb`
20+
- `out/release-latest/rootfs/`
21+
- `out/release-latest/images/imx6ull-aes-emmc.img`
22+
- `out/release-latest/images/imx6ull-aes-sd.img`
23+
- 对应 `.manifest``.sha256` 文件
24+
25+
这些产物由用户本地构建生成,v1.0.0 不随 GitHub Release 交付官方 SD/eMMC binary 镜像。
26+
27+
### 已知限制
28+
29+
- 当前正式支持正点原子阿尔法 i.MX6ULL 开发板。
30+
- 其他 i.MX6ULL 板卡需要自行调整设备树、U-Boot 配置和启动参数。
31+
- v1.0.0 不承诺所有进阶教程、示例项目和多板卡生态完结。
32+
33+
### 后续计划
34+
35+
- 继续扩展驱动教程和应用示例。
36+
- 完善 GitHub Release 自动化与发布 checklist。
37+
- 增加更多板卡适配和回归记录。

document/ci/ci-release.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

document/ci/docker-publish.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<PageHeader icon="🐳" title="Docker 镜像发布" description="IMX-Forge Docker 镜像发布流程,正式版本从 v0.1.0 开始" />
1+
<PageHeader icon="🐳" title="Docker 镜像发布" description="IMX-Forge Docker 镜像发布流程,v1.0.0 是首个轻量可用版本" />
22

33
## 概述
44

55
IMX-Forge 会为正式 release 提供**预构建的 Docker 镜像**,用户无需手动构建即可获得一致的开发环境。镜像通过 GitHub Actions 自动构建并发布到 GitHub Container Registry。
66

77
::: info 版本说明
8-
项目正式 release `v0.1.0` 开始。历史 `v0.5` 是路线图里程碑编号,不等同于正式 Docker tag。
8+
项目首个轻量可用 release `v1.0.0`。历史 `v0.5` 是路线图里程碑编号,不等同于正式 Docker tag。
99
:::
1010

1111
## 镜像标签策略
@@ -14,7 +14,7 @@ IMX-Forge 会为正式 release 提供**预构建的 Docker 镜像**,用户无
1414
|------|----------|--------|------|
1515
| `latest` | 手动触发 / 发布 tag | <Badge type="tip" text="稳定" /> | 推荐给大多数用户 |
1616
| `preview` | 手动触发 | <Badge type="warning" text="实验性" /> | 测试新功能、尝鲜 |
17-
| `v0.1.0`| 发布 tag | <Badge type="tip" text="稳定" /> | 锁定特定版本 |
17+
| `v1.0.0`| 发布 tag | <Badge type="tip" text="稳定" /> | 锁定特定版本 |
1818

1919
## 发布流程
2020

@@ -42,10 +42,10 @@ IMX-Forge 会为正式 release 提供**预构建的 Docker 镜像**,用户无
4242

4343
```bash
4444
# 创建版本 tag
45-
git tag v0.1.0
46-
git push origin v0.1.0
45+
git tag v1.0.0
46+
git push origin v1.0.0
4747

48-
# 自动触发构建:v0.1.0, v0.1, v0, latest
48+
# 自动触发构建:v1.0.0, v1.0, v1, latest
4949
```
5050

5151
## 镜像内容
@@ -74,7 +74,7 @@ docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:latest
7474
docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:preview
7575

7676
# 特定版本
77-
docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:v0.1.0
77+
docker pull ghcr.io/awesome-embedded-learning-studio/imx-forge:v1.0.0
7878
```
7979

8080
### 运行容器

document/ci/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
| [PR Quick Checks](ci-pr.md) | 所有 PR <Badge type="info" text="~5min" /> | 快速验证基础问题 |
88
| [Component Build](ci-build.md) | 路径变化 <Badge type="info" text="~8-15min" /> | 只构建变更组件 |
99
| [Full Build](ci-full.md) | main / 标签 PR <Badge type="warning" text="~25-30min" /> | 完整 4 阶段构建 |
10-
| [Release Build](ci-release.md) | release-* 分支 <Badge type="tip" text="~25-30min" /> | 发布准备 |
1110
| [Docker Image Publish](docker-publish.md) | Tag / 手动 <Badge type="tip" text="~5-10min" /> | 构建发布 Docker 镜像 |
1211

1312
---
@@ -42,12 +41,12 @@ Stage 1: U-Boot → Stage 2: 双内核并行 → Stage 3: BusyBox → Stage 4: R
4241

4342
## 完整触发矩阵
4443

45-
| 你的操作 | ci-pr | ci-build | ci-full | ci-release |
46-
|----------|-------|----------|---------|------------|
44+
| 你的操作 | ci-pr | ci-build | ci-full | docker-publish |
45+
|----------|-------|----------|---------|----------------|
4746
| 打开/更新 PR | ✅ 自动运行 | 🔍 路径触发 |||
4847
| 给 PR 加 `full-build` 标签 || 🔍 | ✅ 运行 ||
4948
| 合并到 main ||| ✅ 自动运行 ||
50-
| 推送 `release-*` 分支 |||| ✅ 自动运行 |
49+
| 推送 `v*.*.*` tag |||| ✅ 自动运行 |
5150

5251
---
5352

@@ -59,9 +58,13 @@ graph TD
5958
A --> C[组件构建 🔍 路径变化时]
6059
A --> D[完整构建 🏷️ full-build 标签]
6160
E[Push main] --> F[完整构建 ✅ 自动]
62-
G[Push release-*] --> H[发布构建 ✅ 自动]
61+
G[Push v*.*.* tag] --> H[Docker 镜像发布 ✅ 自动]
6362
```
6463

64+
::: tip 发布方式
65+
v1.0.0 不设置单独的 Release workflow,也不随 GitHub Release 交付官方 SD/eMMC binary 镜像。发布时创建 `v*.*.*` tag 触发 Docker 镜像发布;源码、发布说明和文档站作为主要交付内容。
66+
:::
67+
6568
---
6669

6770
## 详细文档
@@ -70,7 +73,6 @@ graph TD
7073
<ChapterLink href="ci-pr" variant="sub">PR Quick Checks — 快速检查详解</ChapterLink>
7174
<ChapterLink href="ci-build" variant="sub">Component Build — 组件构建详解</ChapterLink>
7275
<ChapterLink href="ci-full" variant="sub">Full Build — 完整构建详解</ChapterLink>
73-
<ChapterLink href="ci-release" variant="sub">Release Build — 发布构建详解</ChapterLink>
7476
<ChapterLink href="docker-publish" variant="sub">Docker Image Publish — 镜像发布详解</ChapterLink>
7577
</ChapterNav>
7678

0 commit comments

Comments
 (0)