Skip to content

ci: rename ci.yml to check.yaml and add deploy workflow#29

Merged
ZR233 merged 8 commits intodrivercraft:mainfrom
DeathWish5:main
Jan 29, 2026
Merged

ci: rename ci.yml to check.yaml and add deploy workflow#29
ZR233 merged 8 commits intodrivercraft:mainfrom
DeathWish5:main

Conversation

@DeathWish5
Copy link
Contributor

  • Rename ci.yml to check.yaml with updated workflow name and job name
  • Add deploy.yml for building and deploying documentation to GitHub Pages

- Fix Cargo.toml categories to use valid crates.io categories
- Add module-level documentation for all public modules
- Add documentation for public structs, enums, and functions
- Add usage examples in doc comments where appropriate

Modules documented:
- build/mod.rs, cargo_builder.rs, config.rs
- ctx.rs
- run/mod.rs, qemu.rs, tftp.rs
- sterm/mod.rs
- menuconfig.rs
- utils.rs
- Add crate-level documentation with usage examples
- Add module-level documentation for data module
- Document public structs, enums, and functions
- Add field-level documentation for configuration types

Modules documented:
- lib.rs
- run.rs
- data/mod.rs, app_data.rs, item.rs, menu.rs, oneof.rs, schema.rs, types.rs
- Add crate-level documentation with usage examples
- Improve README.md with better structure and examples
- Document public structs, enums, and functions
- Add documentation for compression and FIT image modules

Modules documented:
- lib.rs
- compression/mod.rs, gzip.rs, traits.rs
- fit/mod.rs, config.rs, fdt_header.rs
- error.rs
- Add crate-level documentation with usage examples
- Update README.md with improved examples
- Document public structs and methods for UbootShell
- Add documentation for YMODEM protocol implementation
- Document CRC utilities

Modules documented:
- lib.rs
- ymodem.rs
- crc.rs
Add comprehensive .gitignore for Rust projects including:
- Cargo build artifacts (target/, debug/)
- IDE directories (.idea/, .vscode/)
- OS generated files (.DS_Store, Thumbs.db)
- Coverage and profiling files
- Environment files
Restore the original .gitignore that includes project-specific entries
like .qemu.toml, .uboot.toml, and schema files that were accidentally
removed in 4ab467c.

Restored entries:
- /.vscode
- /.project*
- .spec-workflow
- .claude
- .*-schema.json
- .qemu.toml
- .uboot.toml
- Rename ci.yml to check.yaml with updated workflow name and job name
- Add workflow_call trigger to allow reuse by other workflows
- Add deploy.yml for building and deploying documentation to GitHub Pages
@ZR233 ZR233 merged commit b34a16a into drivercraft:main Jan 29, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants