Skip to content

docs: point first use to verified v0.1.1 release / 文档：默认指向已验证的 v0.1.1 #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiye merged 1 commit into from
Sep 24, 2026
Merged

docs: point first use to verified v0.1.1 release / 文档：默认指向已验证的 v0.1.1 #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ QuickCoffee 是一台以 Rust 编写、受 CoffeeScript 启发的紧凑字节码
下载归档和同一 Release 的 checksum，再校验、解包并确认版本。请整段执行；`&&` 确保任一步失败后不再继续解包或运行。若有错误，先解决下载、校验或目录问题，再重试，不要跳过校验：

```sh
VERSION=0.1.0
VERSION=0.1.1
TARGET=aarch64-apple-darwin
ARCHIVE="quickcoffee-${VERSION}-${TARGET}.tar.gz"
BASE="https://github.com/coffee-js/quickcoffee/releases/download/v${VERSION}"
Expand All @@ -34,7 +34,7 @@ cd "quickcoffee-${VERSION}-${TARGET}" &&
./qcoffee --version
```

Windows x86_64 请使用同一 Release 的 `quickcoffee-0.1.0-x86_64-pc-windows-msvc.zip`；可复制的 PowerShell 下载、校验和解包命令见[发布与平台归档](docs/releasing.md)。归档不会自动修改 `PATH`，因此以下命令使用 `./`（Windows 使用 `./qcoffee.exe` 和 `./qtest.exe`）。
Windows x86_64 请使用同一 Release 的 `quickcoffee-0.1.1-x86_64-pc-windows-msvc.zip`；可复制的 PowerShell 下载、校验和解包命令见[发布与平台归档](docs/releasing.md)。归档不会自动修改 `PATH`，因此以下命令使用 `./`（Windows 使用 `./qcoffee.exe` 和 `./qtest.exe`）。

### 5 分钟完成第一个日常任务

Expand Down
8 changes: 4 additions & 4 deletions docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

### 固定依赖

QuickCoffee 0.1 暂未发布到 crates.io。Rust 宿主应固定经过验证的 `v0.1.0` 完整 commit，而不是跟随浮动分支：
QuickCoffee 0.1 暂未发布到 crates.io。Rust 宿主应固定经过验证的 `v0.1.1` 完整 commit，而不是跟随浮动分支：

```toml
[dependencies]
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "b3d27d24d15d76786baa21614b9cc2a97b28579e" }
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "95c4866a14647b48c12d5de67b48b2ddc15a287f" }
```

升级时只把 `rev` 替换为已经审阅和测试的新完整 commit。
Expand Down Expand Up @@ -67,11 +67,11 @@ QuickCoffee 不内建进程管理器或系统 capability adapter；这些边界

### Pin the dependency

QuickCoffee 0.1 is not published on crates.io. Rust hosts should pin the complete verified `v0.1.0` commit rather than follow a moving branch:
QuickCoffee 0.1 is not published on crates.io. Rust hosts should pin the complete verified `v0.1.1` commit rather than follow a moving branch:

```toml
[dependencies]
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "b3d27d24d15d76786baa21614b9cc2a97b28579e" }
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "95c4866a14647b48c12d5de67b48b2ddc15a287f" }
```

To upgrade, replace `rev` only with another complete commit that you have reviewed and tested.
Expand Down
20 changes: 10 additions & 10 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Windows PowerShell 可将 `Get-FileHash -Algorithm SHA256` 的结果与 `SHA256S

### 无仓库 checkout 的快速验收

正式 `v0.1.0` 发布后，Linux 或 macOS 用户可以只下载平台归档和 checksum。请整段执行；`&&` 让任一步失败后停止后续命令。遇到错误时先解决对应问题再重试，不要跳过校验或继续运行残留文件：
正式 `v0.1.1` 发布后，Linux 或 macOS 用户可以只下载平台归档和 checksum。请整段执行；`&&` 让任一步失败后停止后续命令。遇到错误时先解决对应问题再重试，不要跳过校验或继续运行残留文件：

```sh
VERSION=0.1.0
VERSION=0.1.1
TARGET=aarch64-apple-darwin
ARCHIVE="quickcoffee-${VERSION}-${TARGET}.tar.gz"
BASE="https://github.com/coffee-js/quickcoffee/releases/download/v${VERSION}"
Expand Down Expand Up @@ -69,7 +69,7 @@ Windows PowerShell 使用同一 release 中的 zip。请整段执行；下载、

```powershell
& {
$Version = "0.1.0"
$Version = "0.1.1"
$Target = "x86_64-pc-windows-msvc"
$Archive = "quickcoffee-$Version-$Target.zip"
$Base = "https://github.com/coffee-js/quickcoffee/releases/download/v$Version"
Expand Down Expand Up @@ -111,11 +111,11 @@ make check

### Rust crate 分发决策

0.1 暂缓 crates.io 发布。CLI 用户使用上述正式 Release；Rust embedding 用户固定经过验证的 `v0.1.0` 完整 commit，不使用浮动分支：
0.1 暂缓 crates.io 发布。CLI 用户使用上述正式 Release；Rust embedding 用户固定经过验证的 `v0.1.1` 完整 commit，不使用浮动分支：

```toml
[dependencies]
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "b3d27d24d15d76786baa21614b9cc2a97b28579e" }
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "95c4866a14647b48c12d5de67b48b2ddc15a287f" }
```

只有真实分发需求出现时才建立独立 crates.io 发布 issue。完整宿主选择见[生产嵌入指南](deployment.md)。
Expand Down Expand Up @@ -152,10 +152,10 @@ On Windows, compare `Get-FileHash -Algorithm SHA256` output with `SHA256SUMS`. T

### Quick acceptance without a repository checkout

After the formal `v0.1.0` release, a Linux or macOS user needs only the platform archive and checksum manifest. Run the entire block; `&&` stops subsequent commands if any step fails. Fix the reported problem before retrying; do not skip verification or continue running leftover files:
After the formal `v0.1.1` release, a Linux or macOS user needs only the platform archive and checksum manifest. Run the entire block; `&&` stops subsequent commands if any step fails. Fix the reported problem before retrying; do not skip verification or continue running leftover files:

```sh
VERSION=0.1.0
VERSION=0.1.1
TARGET=aarch64-apple-darwin
ARCHIVE="quickcoffee-${VERSION}-${TARGET}.tar.gz"
BASE="https://github.com/coffee-js/quickcoffee/releases/download/v${VERSION}"
Expand Down Expand Up @@ -184,7 +184,7 @@ On Windows PowerShell, use the zip from the same release. Run the entire block;

```powershell
& {
$Version = "0.1.0"
$Version = "0.1.1"
$Target = "x86_64-pc-windows-msvc"
$Archive = "quickcoffee-$Version-$Target.zip"
$Base = "https://github.com/coffee-js/quickcoffee/releases/download/v$Version"
Expand Down Expand Up @@ -226,11 +226,11 @@ make check

### Rust crate distribution decision

crates.io publication is deferred for 0.1. CLI users use the formal Release above; Rust embedders pin the complete verified `v0.1.0` commit rather than a moving branch:
crates.io publication is deferred for 0.1. CLI users use the formal Release above; Rust embedders pin the complete verified `v0.1.1` commit rather than a moving branch:

```toml
[dependencies]
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "b3d27d24d15d76786baa21614b9cc2a97b28579e" }
quickcoffee = { git = "https://github.com/coffee-js/quickcoffee.git", rev = "95c4866a14647b48c12d5de67b48b2ddc15a287f" }
```

Open a focused crates.io publication issue only when real distribution demand appears. See the [production embedding cookbook](deployment.md) for the complete host choices.
4 changes: 2 additions & 2 deletions tests/policy_workflow.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ fn deployment_cookbook_reuses_the_verified_worker_contract() {
let cookbook = include_str!("../docs/deployment.md");
let readme = include_str!("../README.md");
let releasing = include_str!("../docs/releasing.md");
let release_revision = "b3d27d24d15d76786baa21614b9cc2a97b28579e";
let release_revision = "95c4866a14647b48c12d5de67b48b2ddc15a287f";

for expected in [
"ExecutionPolicy::isolated_request()",
Expand All @@ -335,5 +335,5 @@ fn deployment_cookbook_reuses_the_verified_worker_contract() {
assert!(cookbook.matches(release_revision).count() >= 2);
assert!(releasing.matches(release_revision).count() >= 2);
assert!(readme.contains("docs/deployment.md"));
assert!(!releasing.contains("quickcoffee = \"0.1.0\""));
assert!(!releasing.contains("quickcoffee = \"0.1.1\""));
}
Loading