Run CI in a docker container (#2)

.github/actions/container/Dockerfile

@@ -0,0 +1,6 @@
+FROM rust:slim-bookworm
+
+RUN apt-get update && apt-get install -y libclang-dev libopusenc-dev
+RUN rustup component add clippy rustfmt
+
+ENTRYPOINT ["sh", "-c"]

.github/actions/container/action.yaml

@@ -0,0 +1,13 @@
+name: Run in Rust/Opusenc container
+description: Executes a command in a container that has the rust toolchain and libopusenc installed
+
+inputs:
+  run:
+    description: the command to run
+    required: true
+
+runs:
+  using: docker
+  image: Dockerfile
+  args:
+    - ${{ inputs.run }}

.github/workflows/ci.yaml

@@ -8,32 +8,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ./.github/actions/container
         with:
-          submodules: true
-      - uses: dtolnay/rust-toolchain@stable
-      - run: cargo fmt --all -- --check
+          run: cargo fmt --all -- --check
 
   clippy:
     name: cargo clippy
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ./.github/actions/container
         with:
-          submodules: true
-      - uses: dtolnay/rust-toolchain@stable
-      - name: Install libopusenc
-        run: sudo apt install libopusenc-dev
-      - run: cargo clippy --all-features
-      - run: cargo clippy --no-default-features
+          run: cargo clippy --all-features && cargo clippy --no-default-features
 
   test:
     name: cargo test
     runs-on: ubuntu-latest
+    container:
+      image: rust:bookworm
     steps:
       - uses: actions/checkout@v3
+      - uses: ./.github/actions/container
         with:
-          submodules: true
-      - uses: dtolnay/rust-toolchain@stable
-      - name: Install libopusenc
-        run: sudo apt install libopusenc-dev
-      - run: cargo test
+          run: cargo test

.github/workflows/docs.yaml

@@ -0,0 +1,27 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+name: Build & Deploy API Reference
+
+jobs:
+  doc:
+    name: cargo doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/container
+        with:
+          run: cargo doc --workspace --no-deps
+      - name: Make docs directory writable
+        run: sudo chmod -R 777 ./target/doc
+      - name: Create redirect to opusenc crate docs
+        run: echo "<meta http-equiv=\"refresh\" content=\"0; url=build_wheel\">" > target/doc/index.html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc

src/error.rs

@@ -6,7 +6,9 @@ use std::{
     fmt::Display,
 };
 
-use num_enum::{FromPrimitive, IntoPrimitive, TryFromPrimitive, TryFromPrimitiveError};
+use num_enum::{FromPrimitive, IntoPrimitive};
+#[cfg(feature = "encoder-options")]
+use num_enum::{TryFromPrimitive, TryFromPrimitiveError};
 
 pub type Result<T> = std::result::Result<T, Error>;
 

src/lib.rs

@@ -7,8 +7,8 @@
 //! # Example
 //!
 //! ```
-//! # use std::io::Read;//!
-//! # use opusenc::{Comments, Encoder, MappingFamily, RecommendedTag};//!
+//! # use std::io::Read;
+//! # use opusenc::{Comments, Encoder, MappingFamily, RecommendedTag};
 //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! let audio_data: Vec<i16> = {
 //!     let mut file = std::fs::File::open("/dev/urandom")?;