Add ignore and no_run to get cargo test to pass. (#1101)

* Add changelog entry and failing CI.

* Add ignore and no_run to get `cargo test` to pass.

.github/workflows/ci.yaml

@@ -88,6 +88,10 @@ jobs:
         if: ${{ matrix.target != 'aarch64-linux-android' }}
         run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.1,vulkan1.2,spv1.3
 
+      - name: workspace test
+        if: ${{ matrix.target != 'aarch64-linux-android' }}
+        run: cargo test --release
+
       # Examples
       - name: cargo check examples
         if: ${{ matrix.target != 'aarch64-linux-android' }}

CHANGELOG.md

@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Changed 🛠
+- [PR#1101](https://github.com/EmbarkStudios/rust-gpu/pull/1101) Add `ignore` and `no_run` to documentation to make `cargo test` pass.
 - [PR#1112](https://github.com/EmbarkStudios/rust-gpu/pull/1112) updated wgpu and winit in example runners
 - [PR#1100](https://github.com/EmbarkStudios/rust-gpu/pull/1100) updated toolchain to `nightly-2023-09-30`
 - [PR#1091](https://github.com/EmbarkStudios/rust-gpu/pull/1091) updated toolchain to `nightly-2023-08-29`

README.md

@@ -34,7 +34,7 @@ However, many things aren't implemented yet. That means that while being technic
 
 ![Sky shader](docs/assets/sky.jpg)
 
-```rust
+```rust,no_run
 use glam::{Vec3, Vec4, vec2, vec3};
 
 #[spirv(fragment)]

crates/spirv-builder/README.md

@@ -10,7 +10,7 @@ It takes care of pulling in the `SPIR-V` backend for Rust, `rustc_codegen_spirv`
 
 ## Example
 
-```rust
+```rust,no_run
 use spirv_builder::{MetadataPrintout, SpirvBuilder};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -23,7 +23,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
 This example will build a shader crate called `my_shaders`. You typically insert this code in your crate's `build.rs` that requires the shader binary. The path to the shader module's binary will be set in the `my_shaders.spv` environment variable, which you can include in your project using something along the lines of:
 
-```rust
+```rust,ignore
 const SHADER: &[u8] = include_bytes!(env!("my_shaders.spv"));
 ```
 

crates/spirv-std/README.md

@@ -10,7 +10,7 @@ This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attr
 
 Here is a small excerpt to see what a shader would look like. See [source][source] for full details of the shader that generates above image.
 
-```rust,no_run
+```rust,ignore
 use spirv_std::spirv;
 use glam::{Vec3, Vec4, vec2, vec3};