docs: update docs for v0.3.0-alpha #100
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Code | |
| on: | |
| push: | |
| branches: | |
| - '*' | |
| - '!staging.tmp' | |
| tags: | |
| - '*' | |
| schedule: | |
| - cron: '40 3 * * *' # every day at 3:40 | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| check: | |
| name: Check | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: [ | |
| ubuntu-latest, | |
| macos-latest, | |
| windows-latest | |
| ] | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Install NASM (Linux) | |
| if: runner.os == 'Linux' | |
| run: sudo apt-get update && sudo apt-get install -y nasm | |
| - name: Install NASM (macOS) | |
| if: runner.os == 'macOS' | |
| run: brew install nasm | |
| - name: Install NASM (Windows) | |
| if: runner.os == 'Windows' | |
| shell: pwsh | |
| run: | | |
| choco install nasm -y | |
| echo "C:\Program Files\NASM" >> $env:GITHUB_PATH | |
| - name: Install Rust Toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| components: rust-src | |
| - name: Run cargo check | |
| run: cargo check --bin axiom_os | |
| build: | |
| name: Build | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: [ | |
| ubuntu-latest, | |
| macos-latest, | |
| windows-latest | |
| ] | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Install NASM (Linux) | |
| if: runner.os == 'Linux' | |
| run: sudo apt-get update && sudo apt-get install -y nasm | |
| - name: Install NASM (macOS) | |
| if: runner.os == 'macOS' | |
| run: brew install nasm | |
| - name: Install NASM (Windows) | |
| if: runner.os == 'Windows' | |
| shell: pwsh | |
| run: | | |
| choco install nasm -y | |
| echo "C:\Program Files\NASM" >> $env:GITHUB_PATH | |
| - name: Install Rust Toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| components: rust-src, llvm-tools-preview | |
| - name: Install bootimage | |
| run: cargo install bootimage --debug | |
| - name: Build bootable kernel image | |
| run: cargo bootimage --bin axiom_os | |
| check_formatting: | |
| name: Check Formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust Toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| components: rustfmt | |
| - name: Run cargo fmt | |
| run: cargo fmt --all -- --check | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Install NASM | |
| run: sudo apt-get update && sudo apt-get install -y nasm | |
| - name: Install Rust Toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| components: clippy, rust-src | |
| - name: Run cargo clippy | |
| run: cargo clippy --bin axiom_os |