Fix doc #94
This file contains 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: CI | |
| on: | |
| pull_request: | |
| push: | |
| branches-ignore: | |
| - 'dependabot/**' | |
| - staging-squash-merge.tmp | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| build: | |
| strategy: | |
| matrix: | |
| toolchain: [stable, nightly] | |
| os: [windows-latest, ubuntu-latest, macos-latest] | |
| exclude: | |
| - os: macos-latest | |
| toolchain: nightly | |
| - os: windows-latest | |
| toolchain: nightly | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-build-${{ matrix.toolchain }}-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| override: true | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev | |
| if: runner.os == 'linux' | |
| - name: Build & run tests | |
| # See tools/ci/src/main.rs for the commands this runs | |
| run: cargo run -p ci -- test | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| RUSTFLAGS: "-C debuginfo=0 -D warnings" | |
| ci: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-ci-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| components: rustfmt, clippy | |
| override: true | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev | |
| - name: CI job | |
| # See tools/ci/src/main.rs for the commands this runs | |
| run: cargo run -p ci -- lints | |
| miri: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 60 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-miri-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly | |
| components: miri | |
| override: true | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev | |
| - name: CI job | |
| run: cargo miri test -p bevy_ecs | |
| env: | |
| # -Zrandomize-layout makes sure we dont rely on the layout of anything that might change | |
| RUSTFLAGS: -Zrandomize-layout | |
| # -Zmiri-disable-isolation is needed because our executor uses `fastrand` which accesses system time. | |
| # -Zmiri-ignore-leaks is needed because running bevy_ecs tests finds a memory leak but its impossible | |
| # to track down because allocids are nondeterministic. | |
| # -Zmiri-tag-raw-pointers is not strictly "necessary" but enables a lot of extra UB checks relating | |
| # to raw pointer aliasing rules that we should be trying to uphold. | |
| MIRIFLAGS: -Zmiri-disable-isolation -Zmiri-ignore-leaks -Zmiri-tag-raw-pointers | |
| check-compiles: | |
| runs-on: ubuntu-latest | |
| needs: ci | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| crates/bevy_ecs_compile_fail_tests/target/ | |
| key: ${{ runner.os }}-cargo-check-compiles-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| override: true | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev | |
| - name: Check Compile | |
| # See tools/ci/src/main.rs for the commands this runs | |
| run: cargo run -p ci -- compile | |
| build-wasm: | |
| strategy: | |
| matrix: | |
| toolchain: [stable, nightly] | |
| os: [ubuntu-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-build-wasm-${{ matrix.toolchain }}-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| target: wasm32-unknown-unknown | |
| override: true | |
| - name: Check wasm | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: check | |
| args: --target wasm32-unknown-unknown --no-default-features --features bevy_winit,x11,hdr,bevy_gltf | |
| build-android: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-build-android-${{ hashFiles('**/Cargo.toml') }} | |
| - name: Uninstall android-31 | |
| run: $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --uninstall "platforms;android-31" | |
| - name: Install Android targets | |
| run: rustup target add aarch64-linux-android armv7-linux-androideabi | |
| - name: Install Cargo APK | |
| run: cargo install --force cargo-apk | |
| - name: Build APK | |
| run: cargo apk build --example android | |
| markdownlint: | |
| runs-on: ubuntu-latest | |
| needs: check-missing-examples-in-docs | |
| if: always() | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # Full git history is needed to get a proper list of changed files within `super-linter` | |
| fetch-depth: 0 | |
| - name: Run Markdown Lint | |
| uses: docker://ghcr.io/github/super-linter:slim-v4 | |
| env: | |
| VALIDATE_ALL_CODEBASE: false | |
| VALIDATE_MARKDOWN: true | |
| DEFAULT_BRANCH: main | |
| # Not needed here as only one Linter is used. | |
| #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| check-markdown-links: | |
| runs-on: ubuntu-latest | |
| needs: markdownlint | |
| if: always() | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: check dead links | |
| continue-on-error: true | |
| id: run1 | |
| uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 | |
| with: | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| config-file: '.github/linters/markdown-link-check.json' | |
| - name: Sleep for 30 seconds | |
| if: steps.run1.outcome=='failure' | |
| run: sleep 30s | |
| shell: bash | |
| - name: check dead links (retry) | |
| continue-on-error: true | |
| id: run2 | |
| if: steps.run1.outcome=='failure' | |
| uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 | |
| with: | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| config-file: '.github/linters/markdown-link-check.json' | |
| - name: Sleep for 30 seconds | |
| if: steps.run2.outcome=='failure' | |
| run: sleep 30s | |
| shell: bash | |
| - name: check dead links (retry 2) | |
| continue-on-error: true | |
| id: run3 | |
| if: steps.run2.outcome=='failure' | |
| uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 | |
| with: | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| config-file: '.github/linters/markdown-link-check.json' | |
| - name: set the status | |
| if: always() | |
| run: | | |
| if ${{ steps.run1.outcome=='success' || steps.run2.outcome=='success' || steps.run3.outcome=='success' }}; then | |
| echo success | |
| else | |
| exit 1 | |
| fi | |
| run-examples: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install Bevy dependencies | |
| run: | | |
| sudo apt-get update; | |
| DEBIAN_FRONTEND=noninteractive sudo apt-get install --no-install-recommends -yq \ | |
| libasound2-dev libudev-dev; | |
| - name: install xvfb, llvmpipe and lavapipe | |
| run: | | |
| sudo apt-get update -y -qq | |
| sudo add-apt-repository ppa:oibaf/graphics-drivers -y | |
| sudo apt-get update | |
| sudo apt install -y xvfb libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-run-examples-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - name: Build bevy | |
| run: | | |
| cargo build --no-default-features --features "bevy_dynamic_plugin,bevy_gilrs,bevy_gltf,bevy_winit,render,png,hdr,x11,bevy_ci_testing,trace,trace_chrome,bevy_audio,vorbis" | |
| - name: Run examples | |
| run: | | |
| for example in .github/example-run/*.ron; do | |
| example_name=`basename $example .ron` | |
| echo "running $example_name - "`date` | |
| time TRACE_CHROME=trace-$example_name.json CI_TESTING_CONFIG=$example xvfb-run cargo run --example $example_name --no-default-features --features "bevy_dynamic_plugin,bevy_gilrs,bevy_gltf,bevy_winit,render,png,hdr,x11,bevy_ci_testing,trace,trace_chrome,bevy_audio,vorbis" | |
| sleep 10 | |
| done | |
| zip traces.zip trace*.json | |
| - name: save traces | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: example-traces.zip | |
| path: traces.zip | |
| check-doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v2 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-check-doc-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev | |
| if: runner.os == 'linux' | |
| - name: Build and check doc | |
| # See tools/ci/src/main.rs for the commands this runs | |
| run: cargo run -p ci -- doc | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| RUSTFLAGS: "-C debuginfo=0" | |
| # This currently report a lot of false positives | |
| # Enable it again once it's fixed - https://github.com/bevyengine/bevy/issues/1983 | |
| # - name: Installs cargo-deadlinks | |
| # run: cargo install --force cargo-deadlinks | |
| # - name: Checks dead links | |
| # run: cargo deadlinks --dir target/doc/bevy | |
| # continue-on-error: true | |
| check-missing-examples-in-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check that examples are present in both README and Cargo | |
| uses: Weibye/action-internal-link-consistency@1.0.0 | |
| with: | |
| source: './examples/' | |
| targets: '[ "./Cargo.toml", "./examples/README.md" ]' | |
| file-types: '[".rs"]' | |
| exclude-folders: '["./examples/ios"]' | |
| exclude-files: '[]' | |
| check-unused-dependencies: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-check-unused-dependencies-${{ hashFiles('**/Cargo.toml') }} | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly | |
| override: true | |
| - name: Installs cargo-udeps | |
| run: cargo install --force cargo-udeps | |
| - name: Install alsa and udev | |
| run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev | |
| - name: Run cargo udeps | |
| run: cargo udeps |