[feat] refactor according to rules and prepare to release

.github/workflows/check.yml

@@ -0,0 +1,44 @@
+name: Quality Checks
+
+on:
+  workflow_call:
+
+jobs:
+  check:
+    name: Quality Checks
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        target:
+          - x86_64-unknown-linux-gnu
+          - x86_64-unknown-none
+          - riscv64gc-unknown-none-elf
+          - aarch64-unknown-none-softfloat
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rust-src, clippy, rustfmt
+          targets: ${{ matrix.target }}
+
+      - name: Check rust version
+        run: rustc --version --verbose
+
+      - name: Check code format
+        run: cargo fmt --all -- --check
+
+      - name: Build
+        run: cargo build --target ${{ matrix.target }} --all-features
+
+      - name: Run clippy
+        run: cargo clippy --target ${{ matrix.target }} --all-features -- -D warnings -A clippy::new_without_default
+
+      - name: Build documentation
+        env:
+          RUSTDOCFLAGS: -D rustdoc::broken_intra_doc_links -D missing-docs
+        run: cargo doc --no-deps --target ${{ matrix.target }} --all-features

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+      - 'v*-pre.*'
+  pull_request:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+jobs:
+  quality-check:
+    uses: ./.github/workflows/check.yml
+
+  test:
+    uses: ./.github/workflows/test.yml
+
+  build-doc:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    needs: quality-check
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Build docs
+        env:
+          RUSTDOCFLAGS: -D rustdoc::broken_intra_doc_links -D missing-docs
+        run: |
+          cargo doc --no-deps --all-features
+          printf '<meta http-equiv="refresh" content="0;url=axdevice_base/index.html">' > target/doc/index.html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
+
+  deploy-doc:
+    name: Deploy to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-doc
+    if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,156 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+      - 'v*.*.*-pre.*'
+
+permissions:
+  contents: write
+
+jobs:
+  check:
+    uses: ./.github/workflows/check.yml
+
+  test:
+    uses: ./.github/workflows/test.yml
+    needs: check
+
+  create-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: check
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Validate tag and branch (HEAD-based)
+        shell: bash
+        run: |
+          set -e
+
+          TAG="${{ github.ref_name }}"
+          TAG_COMMIT=$(git rev-list -n 1 "$TAG")
+
+          git fetch origin main dev
+
+          MAIN_HEAD=$(git rev-parse origin/main)
+          DEV_HEAD=$(git rev-parse origin/dev)
+
+          echo "Tag:        $TAG"
+          echo "Tag commit: $TAG_COMMIT"
+          echo "main HEAD:  $MAIN_HEAD"
+          echo "dev  HEAD:  $DEV_HEAD"
+
+          if [[ "$TAG" == *-pre.* ]]; then
+            if [ "$TAG_COMMIT" != "$DEV_HEAD" ]; then
+              echo "❌ prerelease tag must be created from dev HEAD"
+              exit 1
+            fi
+            echo "✅ prerelease tag validated on dev"
+          else
+            if [ "$TAG_COMMIT" != "$MAIN_HEAD" ]; then
+              echo "❌ stable release tag must be created from main HEAD"
+              exit 1
+            fi
+            echo "✅ stable release tag validated on main"
+          fi
+
+      - name: Verify version consistency
+        run: |
+          # Extract version from git tag (remove 'v' prefix)
+          TAG_VERSION="${{ github.ref_name }}"
+          TAG_VERSION="${TAG_VERSION#v}"
+          # Extract version from Cargo.toml
+          CARGO_VERSION=$(grep -m1 '^version' Cargo.toml | sed 's/.*"\(.*\)"/\1/')
+          echo "Git tag version: $TAG_VERSION"
+          echo "Cargo.toml version: $CARGO_VERSION"
+          if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
+            echo "ERROR: Version mismatch! Tag version ($TAG_VERSION) != Cargo.toml version ($CARGO_VERSION)"
+            exit 1
+          fi
+          echo "Version check passed!"
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: false
+          prerelease: ${{ contains(github.ref_name, '-pre.') }}
+          body: |
+            ## ${{ github.ref_name }}
+
+            - [Documentation](https://docs.rs/axdevice_base)
+            - [crates.io](https://crates.io/crates/axdevice_base)
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-crates:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: check
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Validate tag and branch (HEAD-based)
+        shell: bash
+        run: |
+          set -e
+
+          TAG="${{ github.ref_name }}"
+          TAG_COMMIT=$(git rev-list -n 1 "$TAG")
+
+          git fetch origin main dev
+
+          MAIN_HEAD=$(git rev-parse origin/main)
+          DEV_HEAD=$(git rev-parse origin/dev)
+
+          echo "Tag:        $TAG"
+          echo "Tag commit: $TAG_COMMIT"
+          echo "main HEAD:  $MAIN_HEAD"
+          echo "dev  HEAD:  $DEV_HEAD"
+
+          if [[ "$TAG" == *-pre.* ]]; then
+            if [ "$TAG_COMMIT" != "$DEV_HEAD" ]; then
+              echo "❌ prerelease tag must be created from dev HEAD"
+              exit 1
+            fi
+            echo "✅ prerelease tag validated on dev"
+          else
+            if [ "$TAG_COMMIT" != "$MAIN_HEAD" ]; then
+              echo "❌ stable release tag must be created from main HEAD"
+              exit 1
+            fi
+            echo "✅ stable release tag validated on main"
+          fi
+
+      - name: Verify version consistency
+        run: |
+          # Extract version from git tag (remove 'v' prefix)
+          TAG_VERSION="${{ github.ref_name }}"
+          TAG_VERSION="${TAG_VERSION#v}"
+          # Extract version from Cargo.toml
+          CARGO_VERSION=$(grep -m1 '^version' Cargo.toml | sed 's/.*"\(.*\)"/\1/')
+          echo "Git tag version: $TAG_VERSION"
+          echo "Cargo.toml version: $CARGO_VERSION"
+          if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
+            echo "ERROR: Version mismatch! Tag version ($TAG_VERSION) != Cargo.toml version ($CARGO_VERSION)"
+            exit 1
+          fi
+          echo "Version check passed!"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Dry run publish
+        run: cargo publish --dry-run
+
+      - name: Publish to crates.io
+        run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Run tests
+        run: cargo test --all-features -- --nocapture
+
+      - name: Run doc tests
+        run: cargo test --doc

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-01-24
+
+### Added
+
+- Initial release of `axdevice_base` crate.
+- `BaseDeviceOps` trait: Core interface for all emulated devices.
+- `EmulatedDeviceConfig`: Configuration structure for device initialization.
+- `EmuDeviceType`: Re-exported device type enumeration from `axvmconfig`.
+- `map_device_of_type`: Helper function for runtime device type checking and casting.
+- Trait aliases for common device types:
+  - `BaseMmioDeviceOps`: For MMIO (Memory-Mapped I/O) devices.
+  - `BaseSysRegDeviceOps`: For system register devices (ARM).
+  - `BasePortDeviceOps`: For port I/O devices (x86).
+- Support for multiple architectures: x86_64, AArch64, RISC-V64.
+- `no_std` compatible design.
+
+[Unreleased]: https://github.com/arceos-hypervisor/axdevice_base/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/arceos-hypervisor/axdevice_base/releases/tag/v0.1.0