test: runs example during github ci

Signed-off-by: YdrMaster <[email protected]>

Author: YdrMaster

.github/workflows/workflow.yml

@@ -23,3 +23,8 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
+      - name: Run example
+        uses: actions-rs/cargo@v1
+        with:
+          command: run
+          args: --release --example qemu-virt

CHANGELOG.md

@@ -14,19 +14,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## Unreleased
 
-### Changed
+## [0.2.0-alpha.1](https://github.com/YdrMaster/dtb-walker/releases/tag/0.2.0-alpha.1) - 2022-07-12
 
 - 规范化更新日志格式
 - 字符串统一使用一个封装的 `Str` 类型（包括节点名、属性名、`<string>` 类型的属性值、路径），类似于 `str` 但未检查是否符合 utf-8 编码
 - 格式化 `Str` 不再自带引号
 - 补全文档并禁止不写文档
+- github ci 自动运行一次示例
 
 ---
 
-- standardize the change log
+- standardizes the change log
 - uses an encapsulated `Str` type uniformly for strings (including node name, property name, property value of `<string>`, path), similar to `str` but not checked for utf-8 encoding
 - will not add quotes when formating `Str`
 - completes documentation and missing documentation is denied from now on
+- runs example during github ci
 
 ## [0.1.3](https://github.com/YdrMaster/dtb-walker/releases/tag/v0.1.3) - 2022-06-30
 

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "dtb-walker"
 description = "A simple package for DTB depth-first walking."
-version = "0.2.0"
+version = "0.2.0-alpha.1"
 edition = "2021"
 authors = ["YdrMaster <[email protected]>"]
 repository = "https://github.com/YdrMaster/dtb-walker.git"

examples/qemu-virt.rs

@@ -1,9 +1,9 @@
-use dtb_walker::{utils::indent, Dtb, DtbObj, HeaderError, WalkOperation};
-
-const DEVICE_TREE: &[u8] = include_bytes!("qemu-virt.dtb");
+const DEVICE_TREE: &[u8] = include_bytes!("qemu-virt.dtb");
 const INDENT_WIDTH: usize = 4;
 
-fn main() {
+fn main() -> Result<(), String> {
+    use dtb_walker::{utils::indent, Dtb, DtbObj, HeaderError as E, WalkOperation as Op};
+
     let mut aligned = vec![0usize; DEVICE_TREE.len() / core::mem::size_of::<usize>()];
     unsafe {
         aligned
@@ -13,23 +13,20 @@ fn main() {
 
     let dtb = unsafe {
         Dtb::from_raw_parts_filtered(aligned.as_ptr() as _, |e| {
-            matches!(
-                e,
-                HeaderError::Misaligned(4) | HeaderError::LastCompVersion(16)
-            )
+            matches!(e, E::Misaligned(4) | E::LastCompVersion(16))
         })
     }
-    .unwrap();
+    .map_err(|e| format!("verify header failed: {e:?}"))?;
     dtb.walk(|path, obj| match obj {
         DtbObj::SubNode { name } => {
             println!("{}{path}/{name}", indent(path.level(), INDENT_WIDTH));
-            WalkOperation::StepInto
+            Op::StepInto
         }
         DtbObj::Property(prop) => {
             let indent = indent(path.level(), INDENT_WIDTH);
             println!("{indent}{prop:?}");
-            WalkOperation::StepOver
+            Op::StepOver
         }
     });
-    println!("ok");
+    Ok(())
 }

src/header.rs

@@ -1,6 +1,5 @@
-use core::ops::Range;
-
-use crate::{is_aligned, U32BigEndian};
+use crate::{is_aligned, U32BigEndian};
+use core::ops::Range;
 
 pub(crate) struct FdtHeader {
     magic: U32BigEndian,